{ "openapi": "3.0.0", "info": { "title": "Sage Business Cloud Accounting - Accounts", "description": "Documentation of the Sage Business Cloud Accounting API.", "contact": { "name": "Sage Business Cloud Accounting API Team", "url": "mailto:sbc-accounting-api-developers@sage.com" }, "version": "3.1" }, "servers": [ { "url": "https://api.accounting.sage.com/v3.1" } ], "x-tagGroups": [ { "name": "Chart of Accounts", "tags": [ "Coa Accounts", "Coa Templates", "Ledger Accounts", "Ledger Account Classifications", "Ledger Account Types" ] }, { "name": "Transactions", "tags": [ "Journals", "Journal Codes", "Journal Code Types", "Ledger Entries", "Transactions", "Transaction Types" ] }, { "name": "Attachments", "tags": [ "Attachments", "Attachment Context Types" ] }, { "name": "Banking", "tags": [ "bank_accounts", "Bank Accounts", "Bank Account Types", "Bank Deposits", "Bank Reconciliations", "Bank Transfers" ] }, { "name": "Contacts", "tags": [ "Addresses", "Address Types", "Address Regions", "Bank Deposits", "Contacts", "Contact Types", "Contact People", "Contact Person Types", "Countries", "Country Groups" ] }, { "name": "Currencies", "tags": [ "Business Exchange Rates", "Currencies", "Exchange Rates", "Live Exchange Rates" ] }, { "name": "Status Codes & Types", "tags": [ "Quick Entry Types", "Artefact Statuses", "EU Goods Services Types" ] }, { "name": "Purchase Transactions", "tags": [ "Purchase Invoices", "Purchase Credit Notes", "Purchase Quick Entries" ] }, { "name": "Sales Transactions", "tags": [ "Sales Invoices", "Sales Credit Notes", "Sales Estimates", "Sales Quotes", "Sales Quick Entries", "EU Sales Descriptions" ] }, { "name": "Opening Balances", "tags": [ "Contact Opening Balances", "Contact Opening Balance Types", "Bank Opening Balances", "Ledger Account Opening Balances", "Opening Balance Journals" ] }, { "name": "Payments and Receipts", "tags": [ "Contact Allocations", "Payment Methods", "Contact Payments", "Other Payments", "Unallocated Artefacts" ] }, { "name": "Products and Services", "tags": [ "Catalog Item Types", "Product Sales Price Types", "Products", "Services", "Service Rate Types", "Stock Items", "Stock Movements" ] }, { "name": "Reporting", "tags": [ "Trial Balance" ] }, { "name": "Settings", "tags": [ "Analysis Type Categories", "Analysis Types", "Business Activity Types", "Business Settings", "Business Types", "Cis Settings", "Email Settings", "Financial Settings", "Income Tax Settings", "Invoice Settings", "Hosted Artefact Payment Settings", "Legal Form Types", "Country Of Registrations" ] }, { "name": "Taxes", "tags": [ "Draft Tax Returns", "Tax Determinations", "Tax Profiles", "Tax Rates", "Tax Return Frequencies", "Tax Schemes", "Tax Offices", "Tax Returns", "Tax Types" ] }, { "name": "User Accounts", "tags": [ "Businesses", "User" ] } ], "tags": [ { "name": "Businesses", "description": "This endpoint holds information about all the businesses the authorized user has access to. The businesses API is must be used to retrieve the business ID before accessing any other API endpoints." }, { "name": "User", "description": "This endpoint holds information about the currently authenticated user." }, { "name": "Coa Accounts", "description": "Operations about Coa Accounts" }, { "name": "Coa Templates", "description": "Operations about Coa Templates" }, { "name": "Ledger Accounts", "description": "Operations about Ledger Accounts" }, { "name": "Ledger Account Classifications", "description": "Operations about Ledger Account Classifications" }, { "name": "Ledger Account Types", "description": "Operations about Ledger Account Types" }, { "name": "Journals", "description": "Operations about Journals" }, { "name": "Journal Codes", "description": "Operations about Journal Codes" }, { "name": "Journal Code Types", "description": "Operations about Journal Code Types" }, { "name": "Ledger Entries", "description": "Operations about Ledger Entries" }, { "name": "Transactions", "description": "Operations about Transactions" }, { "name": "Transaction Types", "description": "Operations about Transaction Types" }, { "name": "Attachments", "description": "An Attachment is a file that is uploaded into Sage Accounting. It always belongs to an item in the application, e.g. a Sales Invoice or a Contact. This relation is defined in each Attachment via the Attachment Context and the Attachment Context Type, which you can also use to filter existing Attachments. You can retrieve all allowed context types via the Attachment Context Type endpoint." }, { "name": "Attachment Context Types", "description": "Attachment Context Types define the available items you can upload Attachments to. The list includes all types of Invoices, Credit Notes, Payments and Contacts. If you want to upload Attachments that do not belong to one of these types, you can use the Context Type BUSINESS. Attachment Context Types do not change often, so it makes sense to cache this data in your client if you need it." }, { "name": "bank_accounts", "description": "Operations about bank_accounts" }, { "name": "Bank Accounts", "description": "Bank Accounts are a reflection of real-life bank accounts for the associated business. They are used to manage most transactional activity in Sage Business Cloud Accounting as well as track balances. The bank_account_type_id is a required attribute which can only be updated while the bank account has no associated activity. The API allows you to create, delete, update and show bank accounts." }, { "name": "Bank Account Types", "description": "The bank account type is unique to a particular bank account and dictates the different kinds of transactions that can be recorded against the Bank Account itself." }, { "name": "Bank Deposits", "description": "Bank Deposits, unlike bank transfers can only be used to move funds from bank accounts with bank account type CASH_IN_HAND. However the destination account can be of any type. The API allows you to show, create and delete bank deposits." }, { "name": "Bank Reconciliations", "description": "Bank Reconciliations are mainly used in the front end of the application to ensure that the business bank accounts match any real-life transactions and statements. The API allows show, create and update however only certain parameters are valid for POST requests." }, { "name": "Bank Transfers", "description": "Like Bank Deposits, Bank Transfers are used to move funds from one bank account to another. The origin can be of any bank account type other than CASH_IN_HAND and destination bank account can be of any bank account type. The API allows you to show, create, update and delete bank transfers." }, { "name": "Addresses", "description": "Addresses can be associated with Contacts and with Bank Accounts, either as Main Addresses or Delivery Addresses. When you create an Address, you will need to specify an associated contact via its ID. When creating a Contact, however, you can specify address data and the address is automatically created in the background. Thus, it makes sense create addresses only for existing contacts to save requests." }, { "name": "Address Types", "description": "An Address Type is used to categorize Addresses, such as Accounts, Sales, Delivery etc. This is a subresource to the Addresses resource and referenced in the Addresses endpoint as an association." }, { "name": "Address Regions", "description": "Address Regions are used to handle region specific tax rates and are referenced in several resources across the Accounting API. They represent a State in the USA or a Province in Canada. This endpoint is immutable and only here for your convenience, i.e. to be used in (drop-down) lists etc." }, { "name": "Contacts", "description": "Contacts in Sage Business Cloud Accounting represent the companies a user of Sage Accounting does business with. They can be either customers or suppliers/vendors. For most transactions in Accounting, Contacts are involved: Invoicing, Payments, Banking, โ€ฆ Do not confuse Contacts with Contact Persons, who represent the staff of a company." }, { "name": "Contact Types", "description": "This endpoint represents the different types that contacts can be stored as e.g. Customer or Supplier/Vendor. This is a subresource to the Contact resource and referenced in the Contact endpoint as an association. Since the contact type is compulsory when creating a Contact, you can use this endpoint to get their IDs (for use as association) as well as a human readable label." }, { "name": "Contact People", "description": "A Contact Person represents a person in the staff of a company the user does business with. You can think of a Contact Person as of a staff member who works at one of the company's addresses (subsidiaries). Thus, the associations are as follows: a company (endpoint \"Contact\") has at least one address (endpoint \"Address\"), which again has at least one contact person (endpoint \"Contact Persons\")." }, { "name": "Contact Person Types", "description": "A Contact Person Type is used to categorize Contact Persons, such as Accounts, Sales, Purchasing etc. This is a subresource to the Contact Person resource and referenced in the Contact Person endpoint as an association. Since the contact person type is compulsory when creating a Contact Person, you can use this endpoint to get their IDs (for use as association) as well as a human readable label." }, { "name": "Countries", "description": "This endpoint represents the countries as they are stored in Sage Business Cloud Accounting. This is a subresource to the Address resource and referenced in the Address endpoint as an association. Since the country is compulsory when creating an Address, you can use this endpoint to get their IDs (for use as association) as well as a human readable label." }, { "name": "Country Groups", "description": "The Country Group categorizes Country resources. Possible values are ALL, CA, EU, GBIE and US." }, { "name": "Draft Tax Returns", "description": "This endpoint provides detailed information about draft tax returns and allows for their creation and deletion." }, { "name": "Tax Determinations", "description": "Operations about Tax Determinations" }, { "name": "Tax Profiles", "description": "Operations about Tax Profiles" }, { "name": "Tax Rates", "description": "Operations about Tax Rates" }, { "name": "Tax Return Frequencies", "description": "Operations about Tax Return Frequencies" }, { "name": "Tax Schemes", "description": "Operations about Tax Schemes" }, { "name": "Tax Returns", "description": "Operations about Tax Returns" }, { "name": "Tax Types", "description": "Operations about Tax Types" }, { "name": "Business Exchange Rates", "description": "This endpoint exposes exchange rates defined for the business. Each exchange rate has a rate to convert the business' base currency to a foreign one and vice versa. The `base_currency` used by the current business is exposed on the Financial Settings endpoint. Please be advised that only businesses that have `multi_currency_enabled` set to `true` on the `financial_settings` may use other currencies than their base currency, even if exchange rates are available on this endpoint. This endpoint exposes Business Exchanges Rates, ie. rates defined by the user. The `use_live_exchange_rates` attribute on the Financial Settings endpoint tells you whether the business uses live rates or those exposed here." }, { "name": "Currencies", "description": "This endpoint exposes the currencies available in Accounting. The `base_currency` used by the current business is exposed on the `financial_settings` endpoint. Please be advised that only businesses that have `multi_currency_enabled` set to `true` on the Financial Settings may use other currencies than their base currency. Currencies do not change often, so it makes sense to cache this data in your client if you need it." }, { "name": "Exchange Rates", "description": "This endpoint exposes exchange rates available for a business. Each exchange rate has a rate to convert the business' base currency to a foreign one and vice versa. The `base_currency` used by the current business is exposed on the Financial Settings endpoint. Please be advised that only businesses that have `multi_currency_enabled` set to `true` on the `financial_settings` may use other currencies than their base currency, even if exchange rates are available on this endpoint. This endpoint combines Business Exchanges Rates, ie. rates defined by the user, with Live Exchange Rates, which are updated automatically. If there is no business defined rate for a currency available in Accounting, a Live Exchange Rate is exposed. The `use_live_exchange_rates` attribute on the Financial Settings endpoint tells you whether the business uses live rates or business defined ones." }, { "name": "Live Exchange Rates", "description": "This endpoint exposes automatically updated exchange rates available for a business. Each exchange rate has a rate to convert the business' base currency to a foreign one and vice versa. The `base_currency` used by the current business is exposed on the Financial Settings endpoint. Please be advised that only businesses that have `multi_currency_enabled` set to `true` on the `financial_settings` may use other currencies than their base currency, even if exchange rates are available on this endpoint. This endpoint exposes Live Exchange Rates, which are updated automatically. The `use_live_exchange_rates` attribute on the Financial Settings endpoint tells you whether the business uses the rates exposes here or user defined rates, which are available on the Business Exchange Rates endpoint." }, { "name": "Quick Entry Types", "description": "Operations about Quick Entry Types" }, { "name": "Artefact Statuses", "description": "Operations about Artefact Statuses" }, { "name": "EU Goods Services Types", "description": "Operations about EU Goods Services Types" }, { "name": "Purchase Credit Notes", "description": "This endpoint allows the reading and writing access to incoming credited notes, available in the web frontend at the \"Purchases\" menu item." }, { "name": "Purchase Invoices", "description": "This endpoint allows the reading and writing access to incoming invoices, available in the web frontend at the \"Purchases\" menu item." }, { "name": "Purchase Quick Entries", "description": "This endpoint allows the reading and writing access to quick entries as available in the web frontend at the \"Purchases\" menu item." }, { "name": "EU Sales Descriptions", "description": "This is a static endpoint, providing you with consistent eu_sales_description IDs used at the key eu_sales_description_id when manipulating (e.g. invoice-) line items." }, { "name": "Sales Credit Notes", "description": "This endpoint allows the reading and writing access to customer credit notes that are available in the web frontend at the \"Sales\" menu item." }, { "name": "Sales Estimates", "description": "This endpoint allows the reading and writing access to sales estimates, available in the web frontend at the \"Sales\" menu item." }, { "name": "Sales Invoices", "description": "This endpoint allows the reading and writing access to outgoing invoices, available in the web frontend at the \"Sales\" menu item." }, { "name": "Sales Quick Entries", "description": "This endpoint allows the reading and writing access to quick entries that are available in the web frontend at the \"Sales\" menu item." }, { "name": "Sales Quotes", "description": "This endpoint allows the reading and writing access to outgoing quotes, available in the web frontend at the \"Sales\" menu item." }, { "name": "Hosted Artefact Payment Settings", "description": "For sales invoices it is possible to generate a link that can be used to view this invoice online. By default, this invoice view comes with a payment button, allowing the viewer to use Stripe to pay the invoice. With this endpoint you can disable this button thus payment. To do this, specify the ID of the invoice and \"disable_payment: true\". It is not possible to specify \"disable_payment: false\"." }, { "name": "Contact Opening Balances", "description": "Invoices or credit notes which were created in a previous system and are outstanding at the point of transferring to Sage Business Cloud Accounting are treated as Contact Opening Balances. Contact Opening Balances must be dated prior to the Start Date (the date the business started entering data into Sage Business Cloud Accounting). The resource at this endpoint enables creation of customer or supplier Opening Balances, return details of Opening Balances recorded or update/deletion these values." }, { "name": "Contact Opening Balance Types", "description": "This endpoint provides you with type IDs that you can dynamically insert into POST data to /contact_opening_balances, i.e. at the property contact_opening_balance_type_id. Currently there are two possible types: INVOICE and CREDIT_NOTE." }, { "name": "Bank Opening Balances", "description": "The balance of a bank account brought forward from a previous system at the point of transferring to Sage Business Cloud Accounting is treated as a Bank Opening Balance. A Bank Opening Balance must be dated prior to the Start Date (the date the business started entering data into Sage Business Cloud Accounting). The resource at this endpoint enables creation of Bank Opening Balances, return details of Opening Balances recorded or update/deletion of these values. Where a balance is added to an account after the Start Date, a bank transfer should be used instead of an Opening Balance." }, { "name": "Trial Balance", "description": "A trial balance is a list of all the general ledger accounts (both revenue and capital). Each nominal ledger account will hold either a debit balance or a credit balance. Additionally to the balances at the start and end dates you will get the sums of all debit and credit transactions during the specified period." }, { "name": "Opening Balance Journals", "description": "The balances on ledger accounts brought forward from a previous system at the point of transferring to Sage Business Cloud Accounting can be entered as Journal Opening Balances. A Journal Opening Balance must be dated prior to the Start Date (the date the business started entering data into Sage Business Cloud Accounting). The resource at this endpoint enables creation of Journal Opening Balances which give the balances of multiple ledger accounts at a point in time, updating or deleting such balances. These values are normally brought forward from a Trial Balance produced from the previous system." }, { "name": "Contact Allocations", "description": "This endpoint allows you to allocate e.g. a sales credit note to a sales invoice, thus paying the invoice with the credit note. A contact allocation is therefore a transaction from one such artefact to another, given they have the same contact. The actual amount recorded needs to be specified for each artefact allocated, and all amounts need to sum up to zero." }, { "name": "Payment Methods", "description": "This is a static endpoint, providing you with consistent payment method IDs to be used at the key payment_method_id in /contact_payments, /other_payments, and as default_payment_method_id /bank_account upon creating of updating resources. Naturally, only reading access is possible." }, { "name": "Contact Payments", "description": "A contact payment is a payment that relates to a contact and an artefact that requires payment, i.e. usually an invoice. Incoming and outgoing payments are both handled in this endpoint; use the transaction_type_id to distinguish payments from receipts (from the perspective of the business)." }, { "name": "Other Payments", "description": "Just as a Contact Payment, an Other Payment relates to a contact, but instead of an artefact that requires payment you need to specify a ledger account as well as the amount that is recorded to it. Thus, you can use this endpoint when you need to book a contact's payment that cannot be associated with a payment-requiring artefact like an invoice. Incoming and outgoing payments are both handled in this endpoint; use the transaction_type_id to distinguish payments from receipts (from the perspective of the business)." }, { "name": "Unallocated Artefacts", "description": "This endpoint compiles a list of all transactions which have an outstanding amount. These are specifically (purchase or sales) invoices, credit notes, quick entries, corrective invoices, contact payments and opening balances. This API allows only SHOW and INDEX actions on this resource." }, { "name": "Catalog Item Types", "description": "Services, stock items, and products count as 'catalog items'. The resource at this endpoint is a formal ID of each of these types. It is used e.g. in the /products endpoint to tag resources in a response as product or stock item, given that both types are returned and cannot be told apart in that response other than by the type information. Only SHOW and INDEX actions are allowed." }, { "name": "Product Sales Price Types", "description": "A product can have several different types of sales prices. You can define your own price types and use them in the prices listed at the attribute 'sales_prices' when creating a product, or just use one of the preconfigured sales price types; in UK these are 'Sales Price', 'Trade', and 'Wholesale', they will differ in other countries/languages." }, { "name": "Products", "description": "Together with services and stock items, products count as 'catalog items'. The resource at this endpoint is a physical product you sell, but without stock keeping information, i.e. items you can create in the UI via 'Products & Services' -> 'New Item', and then select 'Non-Stock - Quantities are not tracked'. Products can be referenced in invoices' line items for example. This endpoint returns stock items alongside with products, though the stock items returned here do not contain their stock-keeping information, thus looking like products. You can tell them apart only by the attribute 'catalog_item_type'." }, { "name": "Service Rate Types", "description": "A service can have several different types of rates. You can define your own rate types and use them in the rates listed at the attribute 'sales_rates' when creating a service, or just use one of the preconfigured service rate types; in UK these are 'Rate' and 'Discounted', they will differ in other countries/languages." }, { "name": "Stock Items", "description": "Together with services and products, stock_items count as 'catalog items'. The resource at this endpoint is a physical product in your stock, i.e. items you can create in the UI via 'Products & Services' -> 'New Item', and then select 'Stock - Quantities in and out are tracked'. As a result of the quantity tracking, stock_items contain more attributes than a single item returned by /products, as they contain quantity tracking and other warehousing information." }, { "name": "Stock Movements", "description": "Stock movements are meta information about stock items both inwards and outwards. An outward stock movement is triggered e.g. when a stock item figures in a sales invoice, an inward stock movement occurs e.g. in opening balances, purchase invoices or when you register a stock increase manually. This endpoint allows you to both view your stock movements as well as adjust stock levels. The reason why the stock movement was triggered can only by inferred from the optional reference attribute, which may contain an invoice's reference code, for example." }, { "name": "Analysis Type Categories", "description": "Operations about Analysis Type Categories" }, { "name": "Analysis Types", "description": "Operations about Analysis Types" }, { "name": "Business Activity Types", "description": "This endpoint is restricted to French businesses specifically and gives information about the commercial nature of the business (e.g. ร‰levage de vaches laitiรจres - Dairy Farming). The business' actual business activity type is dictated by the business settings endpoint where it can be updated. The API allows show and index." }, { "name": "Business Settings", "description": "This endpoint defines numerous global and region specific business level settings in addition to all default ledger_accounts. The API allows show and update requests for this endpoint." }, { "name": "Business Types", "description": "This endpoint is used to read the region specific business types that are available for the associated business (e.g. For UKI businesses SOLE, PARTNER, LIMITED). The business type is dictated by the business settings endpoint where it can be updated. The API allows show and index requests for this endpoint." }, { "name": "Cis Settings", "description": "This endpoint defines Construction Industry Scheme (CIS) settings for UK only businesses. For example, the ability to specify a business as a contractor or subcontractor. The API allows initial create as well as update and show requests for these settings." }, { "name": "Financial Settings", "description": "This endpoint defines a number of global and region specific financial based settings. For example regional tax settings such as tax number. The API allows both show and update requests." }, { "name": "Income Tax Settings", "description": "This endpoint \"Income Tax Settings\" defines settings specific to income tax for UK businesses only. The API is read only." }, { "name": "Invoice Settings", "description": "Although the endpoint is named \"Invoice Settings\" all types of sales transactional settings are managed here in addition to all invoice related settings, including: invoices, quotes, estimates, credit notes etc. The API allows both index and update requests." }, { "name": "Legal Form Types", "description": "This endpoint is restricted to French businesses and returns all legal form types. The business' actual legal form type is dictated by the business settings endpoint where it can be updated. The API allows show and index." }, { "name": "Country Of Registrations", "description": "Every limited business in the UK and Ireland must have a country of registration (E.g. ENGLAND AND WALES). The country of registration is dictated by the business settings endpoint where it can be updated. This endpoint returns a list of the availale countries that are accepted in business settings. The API allows only SHOW and INDEX actions." }, { "name": "Tax Offices", "description": "Operations about Tax Offices" }, { "name": "Email Settings", "description": "Operations about Email Settings" }, { "name": "Ledger Account Opening Balances" }, { "name": "Services" } ], "paths": { "/user": { "get": { "summary": "Returns the user details of the access_token passed in the request header", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nUndefined for core API endpoints", "responses": { "200": { "description": "Returns the User", "content": { "application/json": { "examples": { "response": { "value": { "created_at": "2018-02-16T20:20:09Z", "updated_at": "2018-02-16T20:20:09Z", "displayed_as": "John Doe", "id": "2b486e58632aa6cd6ea8eb5183931ad3", "first_name": "John", "last_name": "Doe", "initials": "JD", "email": "john.doe@somewhere.com", "locale": "en-GB" } } } } } } }, "tags": [ "User" ], "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/user", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/user", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/user", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/user\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/user\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/user\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/user\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/user\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/user\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/user\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates the User", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nUndefined for core API endpoints", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putUser" }, "examples": { "Request example": { "value": { "user": { "first_name": "string", "last_name": "string", "initials": "string", "locale": "en-GB" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates the User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "200 response example": { "value": { "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "displayed_as": "string", "id": "string", "first_name": "string", "last_name": "string", "initials": "string", "email": "string", "locale": "string" } } } } } } }, "tags": [ "User" ], "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/user \\\n --header 'Content-Type: application/json' \\\n --data '{\"user\":{\"first_name\":\"string\",\"last_name\":\"string\",\"initials\":\"string\",\"locale\":\"en-GB\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"user\":{\"first_name\":\"string\",\"last_name\":\"string\",\"initials\":\"string\",\"locale\":\"en-GB\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/user \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"user\":{\"first_name\":\"string\",\"last_name\":\"string\",\"initials\":\"string\",\"locale\":\"en-GB\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/user", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"user\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"initials\": \"string\",\n \"locale\": \"en-GB\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/user\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/user\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"user\\\":{\\\"first_name\\\":\\\"string\\\",\\\"last_name\\\":\\\"string\\\",\\\"initials\\\":\\\"string\\\",\\\"locale\\\":\\\"en-GB\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/user\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n user: {first_name: 'string', last_name: 'string', initials: 'string', locale: 'en-GB'}\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/user\"),\n Content = new StringContent(\"{\\\"user\\\":{\\\"first_name\\\":\\\"string\\\",\\\"last_name\\\":\\\"string\\\",\\\"initials\\\":\\\"string\\\",\\\"locale\\\":\\\"en-GB\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/user\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"user\\\":{\\\"first_name\\\":\\\"string\\\",\\\"last_name\\\":\\\"string\\\",\\\"initials\\\":\\\"string\\\",\\\"locale\\\":\\\"en-GB\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"user\\\":{\\\"first_name\\\":\\\"string\\\",\\\"last_name\\\":\\\"string\\\",\\\"initials\\\":\\\"string\\\",\\\"locale\\\":\\\"en-GB\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/user\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/user\"\n\npayload = {\"user\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"initials\": \"string\",\n \"locale\": \"en-GB\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/trial_balance": { "get": { "tags": [ "Trial Balance" ], "summary": "Returns a trial balance for a date range", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "from_date", "description": "The first day in the date range to query the balance from.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "to_date", "description": "The last day in the date range to query the balance from.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all ledger accounts' trial balances", "content": { "application/json": { "examples": { "response": { "value": { "from_date": "2024-01-01", "to_date": "2024-12-31", "ledger_accounts": [ { "id": "b4cea718a61a451d8eddbf032375f809", "displayed_as": "Stripe283 (1380)", "$path": "/ledger_accounts/b4cea718a61a451d8eddbf032375f809", "opening_balance": { "debit": "804.39", "credit": "0" }, "closing_balance": { "debit": "804.39", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "ccd4db18df44421bbdc93e18ab1427b7", "displayed_as": "Euro Bank Account (1600)", "$path": "/ledger_accounts/ccd4db18df44421bbdc93e18ab1427b7", "opening_balance": { "debit": "0", "credit": "0" }, "closing_balance": { "debit": "0", "credit": "400" }, "debit": "0", "credit": "400" }, { "id": "7a5eab22884911ed84fa0252b90cda0d", "displayed_as": "Late Payment Charges (4400)", "$path": "/ledger_accounts/7a5eab22884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "8.33" }, "closing_balance": { "debit": "0", "credit": "8.33" }, "debit": "0", "credit": "0" }, { "id": "2d0be1262aa346598975ed0c5e4a4d5a", "displayed_as": "Stripe298 (1340)", "$path": "/ledger_accounts/2d0be1262aa346598975ed0c5e4a4d5a", "opening_balance": { "debit": "703.49", "credit": "0" }, "closing_balance": { "debit": "703.49", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "6726182e9fa742798fcda41eb48afad8", "displayed_as": "Petty Cash (1250)", "$path": "/ledger_accounts/6726182e9fa742798fcda41eb48afad8", "opening_balance": { "debit": "0", "credit": "0" }, "closing_balance": { "debit": "0", "credit": "1200" }, "debit": "0", "credit": "1200" }, { "id": "7a5b422f884911ed84fa0252b90cda0d", "displayed_as": "Trade Creditors (2100)", "$path": "/ledger_accounts/7a5b422f884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "52699.63" }, "closing_balance": { "debit": "0", "credit": "55677.75" }, "debit": "0", "credit": "2978.12" }, { "id": "7a5b6c2f884911ed84fa0252b90cda0d", "displayed_as": "Accruals (2110)", "$path": "/ledger_accounts/7a5b6c2f884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "50" }, "closing_balance": { "debit": "0", "credit": "50" }, "debit": "0", "credit": "0" }, { "id": "7a5b2a31884911ed84fa0252b90cda0d", "displayed_as": "Prepayments (1120)", "$path": "/ledger_accounts/7a5b2a31884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "450" }, "closing_balance": { "debit": "0", "credit": "450" }, "debit": "0", "credit": "0" }, { "id": "7a6b6a32884911ed84fa0252b90cda0d", "displayed_as": "Motor Vehicles Depreciation (8050)", "$path": "/ledger_accounts/7a6b6a32884911ed84fa0252b90cda0d", "opening_balance": { "debit": "5520", "credit": "0" }, "closing_balance": { "debit": "5520", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "18313c3bb11742e580e38de612013e2a", "displayed_as": "Paypal GBP IN (1510)", "$path": "/ledger_accounts/18313c3bb11742e580e38de612013e2a", "opening_balance": { "debit": "147.78", "credit": "0" }, "closing_balance": { "debit": "147.78", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "c8ed1840a6d14e11b833a440d1f8af1a", "displayed_as": "Stripe180 (1530)", "$path": "/ledger_accounts/c8ed1840a6d14e11b833a440d1f8af1a", "opening_balance": { "debit": "5924.64", "credit": "0" }, "closing_balance": { "debit": "5924.64", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5e8543884911ed84fa0252b90cda0d", "displayed_as": "Sale of Assets (4200)", "$path": "/ledger_accounts/7a5e8543884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "83.33" }, "closing_balance": { "debit": "0", "credit": "83.33" }, "debit": "0", "credit": "0" }, { "id": "d256da43e3f946e4b130193d81cc339f", "displayed_as": "Paypal GBP IN (1450)", "$path": "/ledger_accounts/d256da43e3f946e4b130193d81cc339f", "opening_balance": { "debit": "502.59", "credit": "0" }, "closing_balance": { "debit": "502.59", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "159041491538432dbab2b5f65e369e56", "displayed_as": "Building Society Account (1240)", "$path": "/ledger_accounts/159041491538432dbab2b5f65e369e56", "opening_balance": { "debit": "9018.41", "credit": "0" }, "closing_balance": { "debit": "9018.41", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "12156f49008b4140b17a97ecb29ea1df", "displayed_as": "Gocardless GBP IN (1430)", "$path": "/ledger_accounts/12156f49008b4140b17a97ecb29ea1df", "opening_balance": { "debit": "594.9", "credit": "0" }, "closing_balance": { "debit": "594.9", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5ad74c884911ed84fa0252b90cda0d", "displayed_as": "Trade Debtors (1100)", "$path": "/ledger_accounts/7a5ad74c884911ed84fa0252b90cda0d", "opening_balance": { "debit": "100131.4", "credit": "0" }, "closing_balance": { "debit": "104854.4", "credit": "0" }, "debit": "4723", "credit": "0" }, { "id": "7a5a8952884911ed84fa0252b90cda0d", "displayed_as": "Motor Vehicles - Accumulated Depreciation (51)", "$path": "/ledger_accounts/7a5a8952884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "5520" }, "closing_balance": { "debit": "0", "credit": "5520" }, "debit": "0", "credit": "0" }, { "id": "c3226d53929048beb9a930f1cb6c4f2a", "displayed_as": "Gocardless GBP IN (1400)", "$path": "/ledger_accounts/c3226d53929048beb9a930f1cb6c4f2a", "opening_balance": { "debit": "396", "credit": "0" }, "closing_balance": { "debit": "396", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a632154884911ed84fa0252b90cda0d", "displayed_as": "Opening Balances (9998)", "$path": "/ledger_accounts/7a632154884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "261.44" }, "closing_balance": { "debit": "0", "credit": "261.44" }, "debit": "0", "credit": "0" }, { "id": "7a639255884911ed84fa0252b90cda0d", "displayed_as": "Sales - Services (4010)", "$path": "/ledger_accounts/7a639255884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "6012" }, "closing_balance": { "debit": "0", "credit": "6012" }, "debit": "0", "credit": "0" }, { "id": "b73ebf58b70c4625b1daf06597724572", "displayed_as": "Stripe894 (1550)", "$path": "/ledger_accounts/b73ebf58b70c4625b1daf06597724572", "opening_balance": { "debit": "21.16", "credit": "0" }, "closing_balance": { "debit": "21.16", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a63695f884911ed84fa0252b90cda0d", "displayed_as": "Suspense (9999)", "$path": "/ledger_accounts/7a63695f884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "1385.4" }, "closing_balance": { "debit": "0", "credit": "1385.4" }, "debit": "0", "credit": "0" }, { "id": "2a625063792e41ff9e772ab51c2ec98f", "displayed_as": "BlackCurrant FInance (1320)", "$path": "/ledger_accounts/2a625063792e41ff9e772ab51c2ec98f", "opening_balance": { "debit": "0", "credit": "53" }, "closing_balance": { "debit": "0", "credit": "53" }, "debit": "0", "credit": "0" }, { "id": "92b8166843a84772997849dbacd70830", "displayed_as": "Gocardless GBP IN (1480)", "$path": "/ledger_accounts/92b8166843a84772997849dbacd70830", "opening_balance": { "debit": "182.4", "credit": "0" }, "closing_balance": { "debit": "182.4", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "d47fbc695161427b9d579d92020c2d1b", "displayed_as": "US Dollar Account (1590)", "$path": "/ledger_accounts/d47fbc695161427b9d579d92020c2d1b", "opening_balance": { "debit": "0", "credit": "0" }, "closing_balance": { "debit": "400", "credit": "0" }, "debit": "400", "credit": "0" }, { "id": "1953c27bb03f48bf99d8d239d50cefd2", "displayed_as": "Stripe731 (1410)", "$path": "/ledger_accounts/1953c27bb03f48bf99d8d239d50cefd2", "opening_balance": { "debit": "732.8", "credit": "0" }, "closing_balance": { "debit": "732.8", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "e5e86a844da111ef963b02a97020826f", "displayed_as": "CIS Tax Liability Withheld (2501)", "$path": "/ledger_accounts/e5e86a844da111ef963b02a97020826f", "opening_balance": { "debit": "0", "credit": "0" }, "closing_balance": { "debit": "0", "credit": "20" }, "debit": "0", "credit": "20" }, { "id": "3f95d2a0daa043919870a27099e98bb5", "displayed_as": "USD account (1500)", "$path": "/ledger_accounts/3f95d2a0daa043919870a27099e98bb5", "opening_balance": { "debit": "0", "credit": "0" }, "closing_balance": { "debit": "100", "credit": "0" }, "debit": "100", "credit": "0" }, { "id": "5c575ca1cfe646bc8f26c81d6c8ee8d2", "displayed_as": "Paypal GBP IN (1420)", "$path": "/ledger_accounts/5c575ca1cfe646bc8f26c81d6c8ee8d2", "opening_balance": { "debit": "2458.71", "credit": "0" }, "closing_balance": { "debit": "2458.71", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d", "opening_balance": { "debit": "168006.29", "credit": "0" }, "closing_balance": { "debit": "170845", "credit": "0" }, "debit": "2838.71", "credit": "0" }, { "id": "7a5f66a6884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Materials (5020)", "$path": "/ledger_accounts/7a5f66a6884911ed84fa0252b90cda0d", "opening_balance": { "debit": "65", "credit": "0" }, "closing_balance": { "debit": "65", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5bc3ae884911ed84fa0252b90cda0d", "displayed_as": "VAT on Purchases (2201)", "$path": "/ledger_accounts/7a5bc3ae884911ed84fa0252b90cda0d", "opening_balance": { "debit": "14827.53", "credit": "0" }, "closing_balance": { "debit": "14886.94", "credit": "0" }, "debit": "59.41", "credit": "0" }, { "id": "7a5b95af884911ed84fa0252b90cda0d", "displayed_as": "VAT on Sales (2200)", "$path": "/ledger_accounts/7a5b95af884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "32371.99" }, "closing_balance": { "debit": "0", "credit": "32569.01" }, "debit": "0", "credit": "197.02" }, { "id": "a036f7b3951e4b39bf39d78906b05da7", "displayed_as": "Stripe4 (1330)", "$path": "/ledger_accounts/a036f7b3951e4b39bf39d78906b05da7", "opening_balance": { "debit": "5.94", "credit": "0" }, "closing_balance": { "debit": "5.94", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5e37b4884911ed84fa0252b90cda0d", "displayed_as": "Sales - Products (4000)", "$path": "/ledger_accounts/7a5e37b4884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "191589.14" }, "closing_balance": { "debit": "0", "credit": "191921.88" }, "debit": "0", "credit": "332.74" }, { "id": "696c42b8c8c44b2ba0cb9797d525f948", "displayed_as": "Bank Current Account (1220)", "$path": "/ledger_accounts/696c42b8c8c44b2ba0cb9797d525f948", "opening_balance": { "debit": "107.53", "credit": "0" }, "closing_balance": { "debit": "107.53", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a653db9884911ed84fa0252b90cda0d", "displayed_as": "Insurance Claims (4930)", "$path": "/ledger_accounts/7a653db9884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "5" }, "closing_balance": { "debit": "0", "credit": "5" }, "debit": "0", "credit": "0" }, { "id": "9cc910badc124b0989b101e57f7caa8e", "displayed_as": "Bank Deposit Account (1230)", "$path": "/ledger_accounts/9cc910badc124b0989b101e57f7caa8e", "opening_balance": { "debit": "830.48", "credit": "0" }, "closing_balance": { "debit": "830.48", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5ecfcf884911ed84fa0252b90cda0d", "displayed_as": "Other income (4900)", "$path": "/ledger_accounts/7a5ecfcf884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "17517.37" }, "closing_balance": { "debit": "0", "credit": "22278.61" }, "debit": "0", "credit": "4761.24" }, { "id": "200512d2ea0e46ff87d5626d6d7d485f", "displayed_as": "Euro Account (1490)", "$path": "/ledger_accounts/200512d2ea0e46ff87d5626d6d7d485f", "opening_balance": { "debit": "0", "credit": "0" }, "closing_balance": { "debit": "0", "credit": "100" }, "debit": "0", "credit": "100" }, { "id": "511371d830764c6fa6b7b6b91822afcd", "displayed_as": "Stripe Account (1360)", "$path": "/ledger_accounts/511371d830764c6fa6b7b6b91822afcd", "opening_balance": { "debit": "829.57", "credit": "0" }, "closing_balance": { "debit": "829.57", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5ef5d8884911ed84fa0252b90cda0d", "displayed_as": "Carriage on Sales (4910)", "$path": "/ledger_accounts/7a5ef5d8884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "90.55" }, "closing_balance": { "debit": "0", "credit": "90.55" }, "debit": "0", "credit": "0" }, { "id": "004240d939c74b63a425ea63098e1420", "displayed_as": "Stripe174 (1290)", "$path": "/ledger_accounts/004240d939c74b63a425ea63098e1420", "opening_balance": { "debit": "116.32", "credit": "0" }, "closing_balance": { "debit": "116.32", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "13a77fda743145368e269a306f3919ea", "displayed_as": "Stripe542 (1310)", "$path": "/ledger_accounts/13a77fda743145368e269a306f3919ea", "opening_balance": { "debit": "6985.53", "credit": "0" }, "closing_balance": { "debit": "6985.53", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a5e5edc884911ed84fa0252b90cda0d", "displayed_as": "Sales Discounts (4020)", "$path": "/ledger_accounts/7a5e5edc884911ed84fa0252b90cda0d", "opening_balance": { "debit": "186.16", "credit": "0" }, "closing_balance": { "debit": "186.16", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a62f9e6884911ed84fa0252b90cda0d", "displayed_as": "Exchange Rate Gains and Losses (8260)", "$path": "/ledger_accounts/7a62f9e6884911ed84fa0252b90cda0d", "opening_balance": { "debit": "0", "credit": "17.83" }, "closing_balance": { "debit": "0", "credit": "17.83" }, "debit": "0", "credit": "0" }, { "id": "7a6282e7884911ed84fa0252b90cda0d", "displayed_as": "Bank Charges and Interest (7900)", "$path": "/ledger_accounts/7a6282e7884911ed84fa0252b90cda0d", "opening_balance": { "debit": "703.73", "credit": "0" }, "closing_balance": { "debit": "703.73", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "163849e847954f66badb3a4bbbb4dc19", "displayed_as": "Bank Account (1200)", "$path": "/ledger_accounts/163849e847954f66badb3a4bbbb4dc19", "opening_balance": { "debit": "0", "credit": "15225.08" }, "closing_balance": { "debit": "0", "credit": "13457.08" }, "debit": "1768", "credit": "0" }, { "id": "c4dd7cebed2b499c818ba5fd0f263cdf", "displayed_as": "Paypal GBP IN (1390)", "$path": "/ledger_accounts/c4dd7cebed2b499c818ba5fd0f263cdf", "opening_balance": { "debit": "519.08", "credit": "0" }, "closing_balance": { "debit": "519.08", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "e5e7b9ee4da111ef963b02a97020826f", "displayed_as": "CIS Labour Expense (5111)", "$path": "/ledger_accounts/e5e7b9ee4da111ef963b02a97020826f", "opening_balance": { "debit": "0", "credit": "0" }, "closing_balance": { "debit": "100", "credit": "0" }, "debit": "100", "credit": "0" }, { "id": "7a696ef3884911ed84fa0252b90cda0d", "displayed_as": "Telephone (7530)", "$path": "/ledger_accounts/7a696ef3884911ed84fa0252b90cda0d", "opening_balance": { "debit": "50", "credit": "0" }, "closing_balance": { "debit": "50", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "f5d19cf58b314e9a8840f55fa67dc459", "displayed_as": "Stripe454 (1350)", "$path": "/ledger_accounts/f5d19cf58b314e9a8840f55fa67dc459", "opening_balance": { "debit": "93.92", "credit": "0" }, "closing_balance": { "debit": "93.92", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "a7e0a1f77a9b4566829ccf8247bdb22d", "displayed_as": "Cash (1210)", "$path": "/ledger_accounts/a7e0a1f77a9b4566829ccf8247bdb22d", "opening_balance": { "debit": "2421", "credit": "0" }, "closing_balance": { "debit": "2421", "credit": "0" }, "debit": "0", "credit": "0" }, { "id": "7a612dff884911ed84fa0252b90cda0d", "displayed_as": "Rent (7100)", "$path": "/ledger_accounts/7a612dff884911ed84fa0252b90cda0d", "opening_balance": { "debit": "453.34", "credit": "0" }, "closing_balance": { "debit": "453.34", "credit": "0" }, "debit": "0", "credit": "0" } ] } } } } } } }, "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/trial_balance?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/trial_balance\"\n\nquerystring = {\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/businesses": { "get": { "summary": "Returns all businesses available to the user.", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nUndefined for core API endpoints", "parameters": [ { "in": "query", "name": "active_only", "description": "Returns active businesses if set to true", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "name", "description": "Use this to filter businesses by business name. A max string length of 255 is permitted", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "product_family", "description": "Use this to filter businesses by product family. Valid values are sbc_payroll and sbc_accounting.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of businesses per request.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 25, "maximum": 500, "default": 25 } }, { "in": "query", "name": "page", "description": "Go to specific page of businesses. The first page is 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Returns all businesses", "content": { "application/json": { "examples": { "response": { "value": { "$total": 8, "$page": 1, "$next": null, "$back": null, "$items_per_page": 2147483647, "$items": [ { "displayed_as": "Sage Uk ltd", "id": "f99d7e3bdd4ae1b27610e262261e1a53", "$path": "/businesses/f99d7e3bdd4ae1b27610e262261e1a53" }, { "displayed_as": "Client 1", "id": "2900655ce8f68e4c799b04d7baa45757", "$path": "/businesses/2900655ce8f68e4c799b04d7baa45757" }, { "displayed_as": "Client 2", "id": "64451b501982b4765a0af2aa0a5d8a94", "$path": "/businesses/64451b501982b4765a0af2aa0a5d8a94" }, { "displayed_as": "Client 3", "id": "9b2f1c85e976fc1fa7076dbffbbaf57f", "$path": "/businesses/9b2f1c85e976fc1fa7076dbffbbaf57f" }, { "displayed_as": "Client 4", "id": "01c93710dac27cab09bc8fd04e44c8fe", "$path": "/businesses/01c93710dac27cab09bc8fd04e44c8fe" }, { "displayed_as": "Client 6", "id": "ab8c5540d82e0a067caff67cc2afb43a", "$path": "/businesses/ab8c5540d82e0a067caff67cc2afb43a" }, { "displayed_as": "Client 7", "id": "27c4ed51f4a6135d888b8914fbe71d02", "$path": "/businesses/27c4ed51f4a6135d888b8914fbe71d02" }, { "displayed_as": "Sage Internal Account", "id": "639f09872db7216ecd5ad6ba692b3cda", "$path": "/businesses/639f09872db7216ecd5ad6ba692b3cda" } ] } } } } } } }, "tags": [ "Businesses" ], "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/businesses?active_only=SOME_BOOLEAN_VALUE&name=SOME_STRING_VALUE&product_family=SOME_STRING_VALUE&items_per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/businesses\"\n\nquerystring = {\"active_only\":\"SOME_BOOLEAN_VALUE\",\"name\":\"SOME_STRING_VALUE\",\"product_family\":\"SOME_STRING_VALUE\",\"items_per_page\":\"SOME_INTEGER_VALUE\",\"page\":\"SOME_INTEGER_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/businesses/{key}": { "get": { "summary": "Returns a business", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nUndefined for core API endpoints", "parameters": [ { "in": "path", "name": "key", "required": true, "description": "The ID of the business. Use `lead` to get your lead business.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a business", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Business" }, "examples": { "200 response example": { "value": { "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "displayed_as": "string", "id": "string", "name": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string" }, "region": "string", "telephone": "string", "mobile": "string", "website": "string", "is_demo": true, "ni_based": true, "subscriptions": [ { "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "displayed_as": "string", "id": "string", "active": true, "status": "string" } ] } } } } } } }, "tags": [ "Businesses" ], "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/businesses/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/businesses/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Business", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nUndefined for core API endpoints", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putBusinesses" }, "examples": { "Request example": { "value": { "business": { "name": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "region": "string", "postal_code": "string", "telephone": "string", "mobile": "string", "website": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Business", "content": { "application/json": { "examples": { "response": { "value": { "created_at": "2016-08-15T15:54:13Z", "updated_at": "2024-02-29T08:07:42Z", "displayed_as": "Sage Internal Account", "id": "639f09872db7216ecd5ad6ba692b3cda", "name": "Sage Internal Account", "address_line_1": "N Park Avenue", "address_line_2": "", "city": "Newcastle Upon Tyne", "postal_code": "NE13 9AA", "country": { "id": "GB", "displayed_as": "United Kingdom" }, "region": "Tyne and Wear", "ni_based": false, "telephone": "01912943317", "mobile": "", "website": "", "is_demo": false, "subscriptions": [ { "created_at": "2016-08-15T15:54:13Z", "updated_at": "2023-11-07T15:55:49Z", "displayed_as": "Accounting", "id": "ACCOUNTING", "active": true, "status": "expired", "accountant_pays": false }, { "created_at": "2017-06-20T10:26:48Z", "updated_at": "2023-11-07T15:55:49Z", "displayed_as": "Payroll 25", "id": "PAYROLL_25", "active": true, "status": "expired", "accountant_pays": false } ], "$path": "/businesses/639f09872db7216ecd5ad6ba692b3cda", "user_roles": [], "user_permissions": [ { "area": "accounting_sales", "role": "full_access" }, { "area": "accounting_catalogs", "role": "full_access" }, { "area": "accounting_journals", "role": "full_access" }, { "area": "accounting_purchases", "role": "full_access" }, { "area": "accounting_contacts", "role": "full_access" }, { "area": "accounting_statutory_reporting", "role": "full_access" }, { "area": "accounting_bank", "role": "full_access" }, { "area": "accounting_reporting", "role": "full_access" }, { "area": "accounting_settings", "role": "full_access" }, { "area": "payroll_access", "role": "full_access" } ] } } } } } } }, "tags": [ "Businesses" ], "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"business\":{\"name\":\"string\",\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"region\":\"string\",\"postal_code\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"website\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"business\":{\"name\":\"string\",\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"region\":\"string\",\"postal_code\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"website\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"business\":{\"name\":\"string\",\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"region\":\"string\",\"postal_code\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"website\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"business\": {\n \"name\": \"string\",\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postal_code\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"website\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"business\\\":{\\\"name\\\":\\\"string\\\",\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/businesses/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n business: {\n name: 'string',\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n region: 'string',\n postal_code: 'string',\n telephone: 'string',\n mobile: 'string',\n website: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"business\\\":{\\\"name\\\":\\\"string\\\",\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"business\\\":{\\\"name\\\":\\\"string\\\",\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"business\\\":{\\\"name\\\":\\\"string\\\",\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/businesses/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/businesses/%7Bkey%7D\"\n\npayload = {\"business\": {\n \"name\": \"string\",\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postal_code\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"website\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/coa_accounts": { "get": { "summary": "Returns all Coa Accounts", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "coa_template_id", "description": "Use this to filter by COA Template", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Coa Accounts changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Coa Accounts per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Coa Accounts", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Coa Accounts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Coa Accounts", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoaAccount" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "control_name": "string", "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "cis_materials": true, "cis_labour": true } ] } } } } } }, "tags": [ "Coa Accounts" ], "operationId": "getCoaAccounts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/coa_accounts?coa_template_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/coa_accounts\"\n\nquerystring = {\"coa_template_id\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/coa_accounts/{key}": { "get": { "summary": "Returns a Coa Account", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Coa Account Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Coa Account (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Coa Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaAccount" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "control_name": "string", "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "cis_materials": true, "cis_labour": true } } } } } } }, "tags": [ "Coa Accounts" ], "operationId": "getCoaAccountsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/coa_accounts/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/coa_accounts/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/coa_templates": { "get": { "summary": "Returns all Coa Templates", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Coa Templates per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Coa Templates", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Coa Templates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "country_id", "description": "Use this to filter by country id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Coa Templates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoaTemplate" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" } } ] } } } } } }, "tags": [ "Coa Templates" ], "operationId": "getCoaTemplates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/coa_templates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/coa_templates\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"country_id\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/coa_templates/{key}": { "get": { "summary": "Returns a Coa Template", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Coa Template Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Coa Template (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Coa Template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoaTemplate" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Coa Templates" ], "operationId": "getCoaTemplatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/coa_templates/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/coa_templates/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/ledger_accounts": { "get": { "summary": "Returns all Ledger Accounts", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Full Access, Restricted Access, Read Only\n* Area: `Purchases`: Full Access, Restricted Access, Read Only\n* Area: `Products & Services`: Full Access, Restricted Access, Read Only\n* Area: `Contacts`: Full Access, Restricted Access, Read Only\n* Area: `Bank`: Full Access, Restricted Access, Read Only\n* Area: `Journals`: Full Access, Restricted Access, Read Only\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Ledger Accounts changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "visible_in", "description": "Use this to limit the response to ledger account types visible in a specific area. Valid values are: banking, sales, expenses, other_payments, other_receipts, journals and reporting", "required": false, "schema": { "type": "string", "enum": [ "sales", "banking", "expenses", "other_payments", "other_receipts", "journals", "reporting" ] } }, { "in": "query", "name": "not_visible_in", "description": "Use this to limit the response to ledger account types not visible in a specific area.", "required": false, "schema": { "type": "string", "enum": [ "sales", "banking", "expenses", "other_payments", "other_receipts", "journals", "reporting" ] } }, { "in": "query", "name": "show_included_in_chart", "description": "Use this to limit the response to ledger accounts that are/are not included in the chart", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "show_control_accounts", "description": "Use this to limit the response to ledger accounts that are/are not control accounts", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "ledger_account_classification_id", "description": "Use this to filter by ledger account classification id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_balance_details", "description": "Use this to display the balance details for ledger accounts between a date range (requires from_date and to_date).", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "exclude_deleted_entries", "description": "Exclude deleted ledger entries.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "from_date", "description": "Calculate balances from this date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Calculate balances to this date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "search", "description": "Use this to filter by the item code or description", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort_order_from_user_setting", "description": "Use this to enable ordering ledger accounts according to user settings. Defaulted to 'false'.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "filter_inactive_bank_accounts", "description": "Use this to filter inactive bank accounts", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Ledger Accounts per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Ledger Accounts", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Accounts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "ledger_account_type_id", "description": "Use this to filter by ledger account type id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Ledger Accounts", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccount" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 } ] } } } } } }, "tags": [ "Ledger Accounts" ], "operationId": "getLedgerAccounts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&visible_in=SOME_STRING_VALUE¬_visible_in=SOME_STRING_VALUE&show_included_in_chart=SOME_BOOLEAN_VALUE&show_control_accounts=SOME_BOOLEAN_VALUE&ledger_account_classification_id=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&sort_order_from_user_setting=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_type_id=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_accounts\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"visible_in\":\"SOME_STRING_VALUE\",\"not_visible_in\":\"SOME_STRING_VALUE\",\"show_included_in_chart\":\"SOME_BOOLEAN_VALUE\",\"show_control_accounts\":\"SOME_BOOLEAN_VALUE\",\"ledger_account_classification_id\":\"SOME_STRING_VALUE\",\"show_balance_details\":\"SOME_BOOLEAN_VALUE\",\"exclude_deleted_entries\":\"SOME_BOOLEAN_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"sort_order_from_user_setting\":\"SOME_BOOLEAN_VALUE\",\"filter_inactive_bank_accounts\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"ledger_account_type_id\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Ledger Account", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postLedgerAccounts" }, "examples": { "Request example": { "value": { "ledger_account": { "ledger_account_type_id": "string", "included_in_chart": true, "name": "string", "display_name": "string", "nominal_code": 1, "ledger_account_classification_id": "string", "tax_rate_id": "string", "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "control_name": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account_id": "string", "cis_materials": true, "cis_labour": true, "gifi_code": 1000 } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Ledger Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccount" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 } } } } } } }, "tags": [ "Ledger Accounts" ], "operationId": "postLedgerAccounts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/ledger_accounts \\\n --header 'Content-Type: application/json' \\\n --data '{\"ledger_account\":{\"ledger_account_type_id\":\"string\",\"included_in_chart\":true,\"name\":\"string\",\"display_name\":\"string\",\"nominal_code\":1,\"ledger_account_classification_id\":\"string\",\"tax_rate_id\":\"string\",\"fixed_tax_rate\":true,\"visible_in_banking\":true,\"visible_in_expenses\":true,\"visible_in_journals\":true,\"visible_in_other_payments\":true,\"visible_in_other_receipts\":true,\"visible_in_reporting\":true,\"visible_in_sales\":true,\"control_name\":\"string\",\"tax_recoverable\":true,\"recoverable_percentage\":0.1,\"non_recoverable_ledger_account_id\":\"string\",\"cis_materials\":true,\"cis_labour\":true,\"gifi_code\":1000}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"ledger_account\":{\"ledger_account_type_id\":\"string\",\"included_in_chart\":true,\"name\":\"string\",\"display_name\":\"string\",\"nominal_code\":1,\"ledger_account_classification_id\":\"string\",\"tax_rate_id\":\"string\",\"fixed_tax_rate\":true,\"visible_in_banking\":true,\"visible_in_expenses\":true,\"visible_in_journals\":true,\"visible_in_other_payments\":true,\"visible_in_other_receipts\":true,\"visible_in_reporting\":true,\"visible_in_sales\":true,\"control_name\":\"string\",\"tax_recoverable\":true,\"recoverable_percentage\":0.1,\"non_recoverable_ledger_account_id\":\"string\",\"cis_materials\":true,\"cis_labour\":true,\"gifi_code\":1000}}' | \\\n http POST https://api.accounting.sage.com/v3.1/ledger_accounts \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"ledger_account\":{\"ledger_account_type_id\":\"string\",\"included_in_chart\":true,\"name\":\"string\",\"display_name\":\"string\",\"nominal_code\":1,\"ledger_account_classification_id\":\"string\",\"tax_rate_id\":\"string\",\"fixed_tax_rate\":true,\"visible_in_banking\":true,\"visible_in_expenses\":true,\"visible_in_journals\":true,\"visible_in_other_payments\":true,\"visible_in_other_receipts\":true,\"visible_in_reporting\":true,\"visible_in_sales\":true,\"control_name\":\"string\",\"tax_recoverable\":true,\"recoverable_percentage\":0.1,\"non_recoverable_ledger_account_id\":\"string\",\"cis_materials\":true,\"cis_labour\":true,\"gifi_code\":1000}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/ledger_accounts", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"ledger_account\": {\n \"ledger_account_type_id\": \"string\",\n \"included_in_chart\": true,\n \"name\": \"string\",\n \"display_name\": \"string\",\n \"nominal_code\": 1,\n \"ledger_account_classification_id\": \"string\",\n \"tax_rate_id\": \"string\",\n \"fixed_tax_rate\": true,\n \"visible_in_banking\": true,\n \"visible_in_expenses\": true,\n \"visible_in_journals\": true,\n \"visible_in_other_payments\": true,\n \"visible_in_other_receipts\": true,\n \"visible_in_reporting\": true,\n \"visible_in_sales\": true,\n \"control_name\": \"string\",\n \"tax_recoverable\": true,\n \"recoverable_percentage\": 0.1,\n \"non_recoverable_ledger_account_id\": \"string\",\n \"cis_materials\": true,\n \"cis_labour\": true,\n \"gifi_code\": 1000\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/ledger_accounts\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_accounts\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_accounts\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n ledger_account: {\n ledger_account_type_id: 'string',\n included_in_chart: true,\n name: 'string',\n display_name: 'string',\n nominal_code: 1,\n ledger_account_classification_id: 'string',\n tax_rate_id: 'string',\n fixed_tax_rate: true,\n visible_in_banking: true,\n visible_in_expenses: true,\n visible_in_journals: true,\n visible_in_other_payments: true,\n visible_in_other_receipts: true,\n visible_in_reporting: true,\n visible_in_sales: true,\n control_name: 'string',\n tax_recoverable: true,\n recoverable_percentage: 0.1,\n non_recoverable_ledger_account_id: 'string',\n cis_materials: true,\n cis_labour: true,\n gifi_code: 1000\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_accounts\"),\n Content = new StringContent(\"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_accounts\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/ledger_accounts\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_accounts\"\n\npayload = {\"ledger_account\": {\n \"ledger_account_type_id\": \"string\",\n \"included_in_chart\": True,\n \"name\": \"string\",\n \"display_name\": \"string\",\n \"nominal_code\": 1,\n \"ledger_account_classification_id\": \"string\",\n \"tax_rate_id\": \"string\",\n \"fixed_tax_rate\": True,\n \"visible_in_banking\": True,\n \"visible_in_expenses\": True,\n \"visible_in_journals\": True,\n \"visible_in_other_payments\": True,\n \"visible_in_other_receipts\": True,\n \"visible_in_reporting\": True,\n \"visible_in_sales\": True,\n \"control_name\": \"string\",\n \"tax_recoverable\": True,\n \"recoverable_percentage\": 0.1,\n \"non_recoverable_ledger_account_id\": \"string\",\n \"cis_materials\": True,\n \"cis_labour\": True,\n \"gifi_code\": 1000\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/ledger_accounts/{key}": { "get": { "summary": "Returns a Ledger Account", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Full Access, Restricted Access, Read Only\n* Area: `Purchases`: Full Access, Restricted Access, Read Only\n* Area: `Products & Services`: Full Access, Restricted Access, Read Only\n* Area: `Contacts`: Full Access, Restricted Access, Read Only\n* Area: `Bank`: Full Access, Restricted Access, Read Only\n* Area: `Journals`: Full Access, Restricted Access, Read Only\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Account Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Ledger Account (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_balance_details", "description": "Use this to display the balance details for ledger accounts between a date range (requires from_date and to_date).", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "exclude_deleted_entries", "description": "Exclude deleted ledger entries.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "from_date", "description": "Calculate balances from this date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Calculate balances to this date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Account (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Ledger Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccount" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 } } } } } } }, "tags": [ "Ledger Accounts" ], "operationId": "getLedgerAccountsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance_details=SOME_BOOLEAN_VALUE&exclude_deleted_entries=SOME_BOOLEAN_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_balance_details\":\"SOME_BOOLEAN_VALUE\",\"exclude_deleted_entries\":\"SOME_BOOLEAN_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Ledger Account", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Account Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putLedgerAccounts" }, "examples": { "Request example": { "value": { "ledger_account": { "ledger_account_type_id": "string", "included_in_chart": true, "name": "string", "display_name": "string", "nominal_code": 1, "ledger_account_classification_id": "string", "tax_rate_id": "string", "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "control_name": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account_id": "string", "cis_materials": true, "cis_labour": true, "gifi_code": 1000 } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Ledger Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccount" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 } } } } } } }, "tags": [ "Ledger Accounts" ], "operationId": "putLedgerAccountsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"ledger_account\":{\"ledger_account_type_id\":\"string\",\"included_in_chart\":true,\"name\":\"string\",\"display_name\":\"string\",\"nominal_code\":1,\"ledger_account_classification_id\":\"string\",\"tax_rate_id\":\"string\",\"fixed_tax_rate\":true,\"visible_in_banking\":true,\"visible_in_expenses\":true,\"visible_in_journals\":true,\"visible_in_other_payments\":true,\"visible_in_other_receipts\":true,\"visible_in_reporting\":true,\"visible_in_sales\":true,\"control_name\":\"string\",\"tax_recoverable\":true,\"recoverable_percentage\":0.1,\"non_recoverable_ledger_account_id\":\"string\",\"cis_materials\":true,\"cis_labour\":true,\"gifi_code\":1000}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"ledger_account\":{\"ledger_account_type_id\":\"string\",\"included_in_chart\":true,\"name\":\"string\",\"display_name\":\"string\",\"nominal_code\":1,\"ledger_account_classification_id\":\"string\",\"tax_rate_id\":\"string\",\"fixed_tax_rate\":true,\"visible_in_banking\":true,\"visible_in_expenses\":true,\"visible_in_journals\":true,\"visible_in_other_payments\":true,\"visible_in_other_receipts\":true,\"visible_in_reporting\":true,\"visible_in_sales\":true,\"control_name\":\"string\",\"tax_recoverable\":true,\"recoverable_percentage\":0.1,\"non_recoverable_ledger_account_id\":\"string\",\"cis_materials\":true,\"cis_labour\":true,\"gifi_code\":1000}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"ledger_account\":{\"ledger_account_type_id\":\"string\",\"included_in_chart\":true,\"name\":\"string\",\"display_name\":\"string\",\"nominal_code\":1,\"ledger_account_classification_id\":\"string\",\"tax_rate_id\":\"string\",\"fixed_tax_rate\":true,\"visible_in_banking\":true,\"visible_in_expenses\":true,\"visible_in_journals\":true,\"visible_in_other_payments\":true,\"visible_in_other_receipts\":true,\"visible_in_reporting\":true,\"visible_in_sales\":true,\"control_name\":\"string\",\"tax_recoverable\":true,\"recoverable_percentage\":0.1,\"non_recoverable_ledger_account_id\":\"string\",\"cis_materials\":true,\"cis_labour\":true,\"gifi_code\":1000}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"ledger_account\": {\n \"ledger_account_type_id\": \"string\",\n \"included_in_chart\": true,\n \"name\": \"string\",\n \"display_name\": \"string\",\n \"nominal_code\": 1,\n \"ledger_account_classification_id\": \"string\",\n \"tax_rate_id\": \"string\",\n \"fixed_tax_rate\": true,\n \"visible_in_banking\": true,\n \"visible_in_expenses\": true,\n \"visible_in_journals\": true,\n \"visible_in_other_payments\": true,\n \"visible_in_other_receipts\": true,\n \"visible_in_reporting\": true,\n \"visible_in_sales\": true,\n \"control_name\": \"string\",\n \"tax_recoverable\": true,\n \"recoverable_percentage\": 0.1,\n \"non_recoverable_ledger_account_id\": \"string\",\n \"cis_materials\": true,\n \"cis_labour\": true,\n \"gifi_code\": 1000\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_accounts/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n ledger_account: {\n ledger_account_type_id: 'string',\n included_in_chart: true,\n name: 'string',\n display_name: 'string',\n nominal_code: 1,\n ledger_account_classification_id: 'string',\n tax_rate_id: 'string',\n fixed_tax_rate: true,\n visible_in_banking: true,\n visible_in_expenses: true,\n visible_in_journals: true,\n visible_in_other_payments: true,\n visible_in_other_receipts: true,\n visible_in_reporting: true,\n visible_in_sales: true,\n control_name: 'string',\n tax_recoverable: true,\n recoverable_percentage: 0.1,\n non_recoverable_ledger_account_id: 'string',\n cis_materials: true,\n cis_labour: true,\n gifi_code: 1000\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"ledger_account\\\":{\\\"ledger_account_type_id\\\":\\\"string\\\",\\\"included_in_chart\\\":true,\\\"name\\\":\\\"string\\\",\\\"display_name\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"ledger_account_classification_id\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"fixed_tax_rate\\\":true,\\\"visible_in_banking\\\":true,\\\"visible_in_expenses\\\":true,\\\"visible_in_journals\\\":true,\\\"visible_in_other_payments\\\":true,\\\"visible_in_other_receipts\\\":true,\\\"visible_in_reporting\\\":true,\\\"visible_in_sales\\\":true,\\\"control_name\\\":\\\"string\\\",\\\"tax_recoverable\\\":true,\\\"recoverable_percentage\\\":0.1,\\\"non_recoverable_ledger_account_id\\\":\\\"string\\\",\\\"cis_materials\\\":true,\\\"cis_labour\\\":true,\\\"gifi_code\\\":1000}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/ledger_accounts/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_accounts/%7Bkey%7D\"\n\npayload = {\"ledger_account\": {\n \"ledger_account_type_id\": \"string\",\n \"included_in_chart\": True,\n \"name\": \"string\",\n \"display_name\": \"string\",\n \"nominal_code\": 1,\n \"ledger_account_classification_id\": \"string\",\n \"tax_rate_id\": \"string\",\n \"fixed_tax_rate\": True,\n \"visible_in_banking\": True,\n \"visible_in_expenses\": True,\n \"visible_in_journals\": True,\n \"visible_in_other_payments\": True,\n \"visible_in_other_receipts\": True,\n \"visible_in_reporting\": True,\n \"visible_in_sales\": True,\n \"control_name\": \"string\",\n \"tax_recoverable\": True,\n \"recoverable_percentage\": 0.1,\n \"non_recoverable_ledger_account_id\": \"string\",\n \"cis_materials\": True,\n \"cis_labour\": True,\n \"gifi_code\": 1000\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/ledger_account_classifications": { "get": { "summary": "Returns all Ledger Account Classifications", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "ledger_account_type_id", "description": "Use this to filter by ledger account type id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Ledger Account Classifications per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Ledger Account Classifications", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Account Classifications (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Ledger Account Classifications", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Ledger Account Classifications" ], "operationId": "getLedgerAccountClassifications", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_account_classifications?ledger_account_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_classifications\"\n\nquerystring = {\"ledger_account_type_id\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/ledger_account_classifications/{key}": { "get": { "summary": "Returns a Ledger Account Classification", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Account Classification Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Account Classification (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Ledger Account Classification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Ledger Account Classifications" ], "operationId": "getLedgerAccountClassificationsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_account_classifications/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_classifications/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/ledger_account_types": { "get": { "summary": "Returns all Ledger Account Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "ledger_account_classification_id", "description": "Use this to filter by ledger account classification id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Ledger Account Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Ledger Account Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Account Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Ledger Account Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Ledger Account Types" ], "operationId": "getLedgerAccountTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_account_types?ledger_account_classification_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_types\"\n\nquerystring = {\"ledger_account_classification_id\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/ledger_account_types/{key}": { "get": { "summary": "Returns a Ledger Account Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Account Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Account Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Ledger Account Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Ledger Account Types" ], "operationId": "getLedgerAccountTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/journals": { "get": { "summary": "Returns all Journals", "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 `Journals`: Read Only, Full Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Journals 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Journals 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Journals per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Journals", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journals (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Journals", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "reference": "string", "description": "string", "total": 0.1, "journal_code": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "journal_lines": [ { "id": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "details": "string", "debit": 0.1, "credit": 0.1, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "include_on_tax_return": true, "tax_reconciled": true, "cleared": true, "bank_reconciled": true, "journal_line_foreign_currency": "string" } ], "migrated": true } ] } } } } } }, "tags": [ "Journals" ], "operationId": "getJournals", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/journals?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journals\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Journal", "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 `Journals`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postJournals" }, "examples": { "Request example": { "value": { "journal": { "date": "2019-08-24", "reference": "string", "description": "string", "total": 0.1, "journal_code": { "name": "string", "code": "string", "journal_code_type_id": "string", "control_name": "string", "reserved": true }, "journal_lines": [ { "ledger_account_id": "string", "debit": 0.1, "credit": 0.1, "details": "string", "analysis_type_categories": [ "string" ], "include_on_tax_return": true } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Journal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "reference": "string", "description": "string", "total": 0.1, "journal_code": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "journal_lines": [ { "id": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "details": "string", "debit": 0.1, "credit": 0.1, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "include_on_tax_return": true, "tax_reconciled": true, "cleared": true, "bank_reconciled": true, "journal_line_foreign_currency": "string" } ], "migrated": true } } } } } } }, "tags": [ "Journals" ], "operationId": "postJournals", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/journals \\\n --header 'Content-Type: application/json' \\\n --data '{\"journal\":{\"date\":\"2019-08-24\",\"reference\":\"string\",\"description\":\"string\",\"total\":0.1,\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true},\"journal_lines\":[{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\",\"analysis_type_categories\":[\"string\"],\"include_on_tax_return\":true}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"journal\":{\"date\":\"2019-08-24\",\"reference\":\"string\",\"description\":\"string\",\"total\":0.1,\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true},\"journal_lines\":[{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\",\"analysis_type_categories\":[\"string\"],\"include_on_tax_return\":true}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/journals \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"journal\":{\"date\":\"2019-08-24\",\"reference\":\"string\",\"description\":\"string\",\"total\":0.1,\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true},\"journal_lines\":[{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\",\"analysis_type_categories\":[\"string\"],\"include_on_tax_return\":true}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/journals", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"journal\": {\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"description\": \"string\",\n \"total\": 0.1,\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": true\n },\n \"journal_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\",\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"include_on_tax_return\": true\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/journals\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journals\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"total\\\":0.1,\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true},\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"include_on_tax_return\\\":true}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journals\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n journal: {\n date: '2019-08-24',\n reference: 'string',\n description: 'string',\n total: 0.1,\n journal_code: {\n name: 'string',\n code: 'string',\n journal_code_type_id: 'string',\n control_name: 'string',\n reserved: true\n },\n journal_lines: [\n {\n ledger_account_id: 'string',\n debit: 0.1,\n credit: 0.1,\n details: 'string',\n analysis_type_categories: ['string'],\n include_on_tax_return: true\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journals\"),\n Content = new StringContent(\"{\\\"journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"total\\\":0.1,\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true},\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"include_on_tax_return\\\":true}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journals\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"total\\\":0.1,\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true},\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"include_on_tax_return\\\":true}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"total\\\":0.1,\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true},\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"include_on_tax_return\\\":true}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/journals\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journals\"\n\npayload = {\"journal\": {\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"description\": \"string\",\n \"total\": 0.1,\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": True\n },\n \"journal_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\",\n \"analysis_type_categories\": [\"string\"],\n \"include_on_tax_return\": True\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/journals/{key}": { "get": { "summary": "Returns a Journal", "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 `Journals`: Read Only, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Journal Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Journal (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journal (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Journal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "reference": "string", "description": "string", "total": 0.1, "journal_code": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "journal_lines": [ { "id": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "details": "string", "debit": 0.1, "credit": 0.1, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "include_on_tax_return": true, "tax_reconciled": true, "cleared": true, "bank_reconciled": true, "journal_line_foreign_currency": "string" } ], "migrated": true } } } } } } }, "tags": [ "Journals" ], "operationId": "getJournalsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/journals/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Journal", "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 `Journals`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Journal Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Journal" } }, "tags": [ "Journals" ], "operationId": "deleteJournalsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journals/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/journals/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/journals/{key}/reissue": { "post": { "summary": "Reissues an existing Journal by voiding the existing one and creating a new one", "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Journals`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Journal GUID.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Reissues an existing Journal by voiding the existing one and creating a new one", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "reference": "string", "description": "string", "total": 0.1, "journal_code": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "journal_lines": [ { "id": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "details": "string", "debit": 0.1, "credit": 0.1, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "include_on_tax_return": true, "tax_reconciled": true, "cleared": true, "bank_reconciled": true, "journal_line_foreign_currency": "string" } ], "migrated": true } } } } } } }, "tags": [ "Journals" ], "operationId": "postJournalsKeyReissue", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http POST https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue\",\n \"method\": \"POST\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journals/%7Bkey%7D/reissue\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue\");\nvar request = new RestRequest(Method.POST);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"POST\", \"/v3.1/journals/%7Bkey%7D/reissue\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journals/%7Bkey%7D/reissue\"\n\nresponse = requests.request(\"POST\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/journal_codes": { "get": { "summary": "Returns all Journal Codes", "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 mentioned role in one of the listed areas:\n* Area: `Journals`: Full Access, Read Only\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Journal Codes 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Journal Codes per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Journal Codes", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journal Codes (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Journal Codes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalCode" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true } ] } } } } } }, "tags": [ "Journal Codes" ], "operationId": "getJournalCodes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/journal_codes?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journal_codes\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Journal Code", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postJournalCodes" }, "examples": { "Request example": { "value": { "journal_code": { "name": "string", "code": "string", "journal_code_type_id": "string", "control_name": "string", "reserved": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Journal Code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCode" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true } } } } } } }, "tags": [ "Journal Codes" ], "operationId": "postJournalCodes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/journal_codes \\\n --header 'Content-Type: application/json' \\\n --data '{\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}' | \\\n http POST https://api.accounting.sage.com/v3.1/journal_codes \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/journal_codes", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/journal_codes\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journal_codes\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journal_codes\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n journal_code: {\n name: 'string',\n code: 'string',\n journal_code_type_id: 'string',\n control_name: 'string',\n reserved: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journal_codes\"),\n Content = new StringContent(\"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journal_codes\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/journal_codes\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journal_codes\"\n\npayload = {\"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/journal_codes/{key}": { "get": { "summary": "Returns a Journal Code", "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 mentioned role in one of the listed areas:\n* Area: `Journals`: Full Access, Read Only\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Journal Code Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journal Code (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Journal Code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCode" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true } } } } } } }, "tags": [ "Journal Codes" ], "operationId": "getJournalCodesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/journal_codes/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Journal Code", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Journal Code Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putJournalCodes" }, "examples": { "Request example": { "value": { "journal_code": { "name": "string", "code": "string", "journal_code_type_id": "string", "control_name": "string", "reserved": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Journal Code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCode" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true } } } } } } }, "tags": [ "Journal Codes" ], "operationId": "putJournalCodesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journal_codes/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n journal_code: {\n name: 'string',\n code: 'string',\n journal_code_type_id: 'string',\n control_name: 'string',\n reserved: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/journal_codes/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\"\n\npayload = {\"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Journal Code", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Journal Code Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Journal Code" } }, "tags": [ "Journal Codes" ], "operationId": "deleteJournalCodesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journal_codes/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/journal_codes/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journal_codes/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/journal_code_types": { "get": { "summary": "Returns all Journal Code Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Country Journal Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Country Journal Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Country Journal Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Journal Code Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalCodeType" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Journal Code Types" ], "operationId": "getJournalCodeTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/journal_code_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journal_code_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/journal_code_types/{key}": { "get": { "summary": "Returns a Journal Code Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Journal Code Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Country Journal Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Journal Code Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCodeType" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Journal Code Types" ], "operationId": "getJournalCodeTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/journal_code_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/journal_code_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/ledger_entries": { "get": { "summary": "Returns all Ledger Entries", "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 `Journals`: Read Only, Full Access", "parameters": [ { "in": "query", "name": "from_date", "description": "Use this to filter by Ledger Entries dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Ledger Entries dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "transaction_id", "description": "Use this to filter by transaction id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "transaction_type_id", "description": "Use this to filter by transaction type id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "journal_code_id", "description": "Use this to filter by journal code id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Ledger 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Ledger Entries per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Ledger Entries", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Entries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "ledger_account_id", "description": "Use this to filter by ledger account id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Ledger Entries", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntry" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "credit": 0.1, "debit": 0.1, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted": true, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "description": "string", "journal_code": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true } } ] } } } } } }, "tags": [ "Ledger Entries" ], "operationId": "getLedgerEntries", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_entries?from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&transaction_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&journal_code_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&ledger_account_id=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_entries\"\n\nquerystring = {\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"transaction_id\":\"SOME_STRING_VALUE\",\"transaction_type_id\":\"SOME_STRING_VALUE\",\"journal_code_id\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"ledger_account_id\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/ledger_entries/{key}": { "get": { "summary": "Returns a Ledger Entry", "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 `Journals`: Read Only, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Entry Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Ledger Entry (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ledger Entry (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Ledger Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerEntry" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "credit": 0.1, "debit": 0.1, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted": true, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "description": "string", "journal_code": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true } } } } } } } }, "tags": [ "Ledger Entries" ], "operationId": "getLedgerEntriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_entries/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_entries/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/transactions": { "get": { "summary": "Returns all Transactions", "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 `Journals`: Read Only, Full Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Transactions 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Transactions dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Transactions dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_from_date", "description": "Use this to filter Transactions by the date they were last updated", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_to_date", "description": "Use this to filter Transactions by the date they were last updated", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Transactions by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Transactions per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Transactions", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Transactions (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "transaction_type_id", "description": "Use this to filter by transaction type id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Transactions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" } ] } } } } } }, "tags": [ "Transactions" ], "operationId": "getTransactions", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/transactions?updated_or_created_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_from_date=SOME_STRING_VALUE&updated_to_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/transactions\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_from_date\":\"SOME_STRING_VALUE\",\"updated_to_date\":\"SOME_STRING_VALUE\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"transaction_type_id\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/transactions/{key}": { "get": { "summary": "Returns a Transaction", "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 `Journals`: Read Only, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Transaction Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand_origin", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Transaction (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Transaction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" } } } } } } }, "tags": [ "Transactions" ], "operationId": "getTransactionsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/transactions/%7Bkey%7D?expand_origin=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/transactions/%7Bkey%7D\"\n\nquerystring = {\"expand_origin\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/transaction_types": { "get": { "summary": "Returns all Transaction Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "valid_for_business", "description": "Use this to filter the transaction types to a business's locale and service", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Transaction Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Transaction Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Transaction Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Transaction Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Transaction Types" ], "operationId": "getTransactionTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/transaction_types?valid_for_business=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/transaction_types\"\n\nquerystring = {\"valid_for_business\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/transaction_types/{key}": { "get": { "summary": "Returns a Transaction Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Transaction Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Transaction Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Transaction Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Transaction Types" ], "operationId": "getTransactionTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/transaction_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/transaction_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/attachments": { "get": { "summary": "Returns all Attachments", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "attachment_context_id", "description": "Use this to filter Attachments by attachment_context_id. Requires filtering by attachment_context_type_id as well", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attachment_context_type_id", "description": "Use this to filter Attachments by attachment_context_type_id. Requires filtering by attachment_context_id as well", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "legacy_attachment_context_type", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "legacy_attachment_context_id", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Attachments 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Attachments 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Attachments per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Attachments", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Attachments (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Attachments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "deleted_at": "2019-08-24T14:15:22Z", "file": "string", "mime_type": "string", "description": "string", "file_extension": "string", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "file_size": 0, "file_name": "string", "$file_path": "string", "attachment_context_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "attachment_context": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_public": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ] } } } } } }, "tags": [ "Attachments" ], "operationId": "getAttachments", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/attachments?attachment_context_id=SOME_STRING_VALUE&attachment_context_type_id=SOME_STRING_VALUE&legacy_attachment_context_type=SOME_STRING_VALUE&legacy_attachment_context_id=SOME_INTEGER_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachments\"\n\nquerystring = {\"attachment_context_id\":\"SOME_STRING_VALUE\",\"attachment_context_type_id\":\"SOME_STRING_VALUE\",\"legacy_attachment_context_type\":\"SOME_STRING_VALUE\",\"legacy_attachment_context_id\":\"SOME_INTEGER_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Attachment", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Restricted Access, Full Access\n* Area: `Purchases`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postAttachments" }, "examples": { "Request example": { "value": { "attachment": { "file": "string", "file_name": "string", "mime_type": "string", "description": "string", "file_extension": "string", "transaction_id": "string", "file_size": 2621440, "attachment_context_type_id": "string", "attachment_context_id": "string", "is_public": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Attachment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "deleted_at": "2019-08-24T14:15:22Z", "file": "string", "mime_type": "string", "description": "string", "file_extension": "string", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "file_size": 0, "file_name": "string", "$file_path": "string", "attachment_context_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "attachment_context": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_public": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } } } } } } }, "tags": [ "Attachments" ], "operationId": "postAttachments", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/attachments \\\n --header 'Content-Type: application/json' \\\n --data '{\"attachment\":{\"file\":\"string\",\"file_name\":\"string\",\"mime_type\":\"string\",\"description\":\"string\",\"file_extension\":\"string\",\"transaction_id\":\"string\",\"file_size\":2621440,\"attachment_context_type_id\":\"string\",\"attachment_context_id\":\"string\",\"is_public\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"attachment\":{\"file\":\"string\",\"file_name\":\"string\",\"mime_type\":\"string\",\"description\":\"string\",\"file_extension\":\"string\",\"transaction_id\":\"string\",\"file_size\":2621440,\"attachment_context_type_id\":\"string\",\"attachment_context_id\":\"string\",\"is_public\":true}}' | \\\n http POST https://api.accounting.sage.com/v3.1/attachments \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"attachment\":{\"file\":\"string\",\"file_name\":\"string\",\"mime_type\":\"string\",\"description\":\"string\",\"file_extension\":\"string\",\"transaction_id\":\"string\",\"file_size\":2621440,\"attachment_context_type_id\":\"string\",\"attachment_context_id\":\"string\",\"is_public\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/attachments", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"attachment\": {\n \"file\": \"string\",\n \"file_name\": \"string\",\n \"mime_type\": \"string\",\n \"description\": \"string\",\n \"file_extension\": \"string\",\n \"transaction_id\": \"string\",\n \"file_size\": 2621440,\n \"attachment_context_type_id\": \"string\",\n \"attachment_context_id\": \"string\",\n \"is_public\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/attachments\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachments\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachments\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n attachment: {\n file: 'string',\n file_name: 'string',\n mime_type: 'string',\n description: 'string',\n file_extension: 'string',\n transaction_id: 'string',\n file_size: 2621440,\n attachment_context_type_id: 'string',\n attachment_context_id: 'string',\n is_public: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachments\"),\n Content = new StringContent(\"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachments\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/attachments\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachments\"\n\npayload = {\"attachment\": {\n \"file\": \"string\",\n \"file_name\": \"string\",\n \"mime_type\": \"string\",\n \"description\": \"string\",\n \"file_extension\": \"string\",\n \"transaction_id\": \"string\",\n \"file_size\": 2621440,\n \"attachment_context_type_id\": \"string\",\n \"attachment_context_id\": \"string\",\n \"is_public\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/attachments/{key}": { "get": { "summary": "Returns a Attachment", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Attachment Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Attachment (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Attachment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "deleted_at": "2019-08-24T14:15:22Z", "file": "string", "mime_type": "string", "description": "string", "file_extension": "string", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "file_size": 0, "file_name": "string", "$file_path": "string", "attachment_context_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "attachment_context": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_public": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } } } } } } }, "tags": [ "Attachments" ], "operationId": "getAttachmentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/attachments/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Attachment", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Restricted Access, Full Access\n* Area: `Purchases`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Attachment Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putAttachments" }, "examples": { "Request example": { "value": { "attachment": { "file": "string", "file_name": "string", "mime_type": "string", "description": "string", "file_extension": "string", "transaction_id": "string", "file_size": 2621440, "attachment_context_type_id": "string", "attachment_context_id": "string", "is_public": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Attachment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "deleted_at": "2019-08-24T14:15:22Z", "file": "string", "mime_type": "string", "description": "string", "file_extension": "string", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "file_size": 0, "file_name": "string", "$file_path": "string", "attachment_context_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "attachment_context": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_public": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } } } } } } }, "tags": [ "Attachments" ], "operationId": "putAttachmentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"attachment\":{\"file\":\"string\",\"file_name\":\"string\",\"mime_type\":\"string\",\"description\":\"string\",\"file_extension\":\"string\",\"transaction_id\":\"string\",\"file_size\":2621440,\"attachment_context_type_id\":\"string\",\"attachment_context_id\":\"string\",\"is_public\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"attachment\":{\"file\":\"string\",\"file_name\":\"string\",\"mime_type\":\"string\",\"description\":\"string\",\"file_extension\":\"string\",\"transaction_id\":\"string\",\"file_size\":2621440,\"attachment_context_type_id\":\"string\",\"attachment_context_id\":\"string\",\"is_public\":true}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"attachment\":{\"file\":\"string\",\"file_name\":\"string\",\"mime_type\":\"string\",\"description\":\"string\",\"file_extension\":\"string\",\"transaction_id\":\"string\",\"file_size\":2621440,\"attachment_context_type_id\":\"string\",\"attachment_context_id\":\"string\",\"is_public\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"attachment\": {\n \"file\": \"string\",\n \"file_name\": \"string\",\n \"mime_type\": \"string\",\n \"description\": \"string\",\n \"file_extension\": \"string\",\n \"transaction_id\": \"string\",\n \"file_size\": 2621440,\n \"attachment_context_type_id\": \"string\",\n \"attachment_context_id\": \"string\",\n \"is_public\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachments/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n attachment: {\n file: 'string',\n file_name: 'string',\n mime_type: 'string',\n description: 'string',\n file_extension: 'string',\n transaction_id: 'string',\n file_size: 2621440,\n attachment_context_type_id: 'string',\n attachment_context_id: 'string',\n is_public: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"attachment\\\":{\\\"file\\\":\\\"string\\\",\\\"file_name\\\":\\\"string\\\",\\\"mime_type\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"file_extension\\\":\\\"string\\\",\\\"transaction_id\\\":\\\"string\\\",\\\"file_size\\\":2621440,\\\"attachment_context_type_id\\\":\\\"string\\\",\\\"attachment_context_id\\\":\\\"string\\\",\\\"is_public\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/attachments/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\"\n\npayload = {\"attachment\": {\n \"file\": \"string\",\n \"file_name\": \"string\",\n \"mime_type\": \"string\",\n \"description\": \"string\",\n \"file_extension\": \"string\",\n \"transaction_id\": \"string\",\n \"file_size\": 2621440,\n \"attachment_context_type_id\": \"string\",\n \"attachment_context_id\": \"string\",\n \"is_public\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Attachment", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Restricted Access, Full Access\n* Area: `Purchases`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Attachment Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Attachment" } }, "tags": [ "Attachments" ], "operationId": "deleteAttachmentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachments/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/attachments/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/attachments/{key}/file": { "get": { "summary": "Returns an Attachment File", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "header", "name": "Accept", "description": "Specify the Accept header of the request.\nIt must always be set to `application/octet-stream` for retrieving files.\n", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key", "description": "The Attachment Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an Attachment File", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "deleted_at": "2019-08-24T14:15:22Z", "file": "string", "mime_type": "string", "description": "string", "file_extension": "string", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "file_size": 0, "file_name": "string", "$file_path": "string", "attachment_context_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "attachment_context": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_public": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } } } } } } }, "tags": [ "Attachments" ], "operationId": "getAttachmentsKeyFile", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file \\\n --header 'Accept: SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file \\\n Accept:SOME_STRING_VALUE", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file\",\n \"method\": \"GET\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\"\n }\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachments/%7Bkey%7D/file\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file\"),\n Headers =\n {\n { \"Accept\", \"SOME_STRING_VALUE\" },\n },\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file\");\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Accept\", \"SOME_STRING_VALUE\");\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nheaders = { 'Accept': \"SOME_STRING_VALUE\" }\n\nconn.request(\"GET\", \"/v3.1/attachments/%7Bkey%7D/file\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachments/%7Bkey%7D/file\"\n\nheaders = {\"Accept\": \"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/attachment_context_types": { "get": { "summary": "Returns all Attachment Context Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Attachment Context Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Attachment Context Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Attachment Context Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Attachment Context Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Attachment Context Types" ], "operationId": "getAttachmentContextTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/attachment_context_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachment_context_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/attachment_context_types/{key}": { "get": { "summary": "Returns a Attachment Context Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Attachment Context Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Attachment Context Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Attachment Context Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Attachment Context Types" ], "operationId": "getAttachmentContextTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/attachment_context_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/attachment_context_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/bank_accounts": { "get": { "summary": "Returns all Bank Accounts", "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, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Bank Accounts changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Bank Accounts 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Bank Accounts (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "exclude_stripe", "description": "Use this to filter out Stripe Bank Accounts", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "filter_inactive_bank_accounts", "description": "Use this to filter inactive bank accounts", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "appName", "description": "The App Name", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Bank Accounts per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Bank Accounts", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Bank Accounts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Bank Accounts", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } } ] } } } } } }, "tags": [ "Bank Accounts" ], "operationId": "getBankAccounts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_accounts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&nested_attributes=SOME_STRING_VALUE&exclude_stripe=SOME_BOOLEAN_VALUE&filter_inactive_bank_accounts=SOME_BOOLEAN_VALUE&appName=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_accounts\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"exclude_stripe\":\"SOME_BOOLEAN_VALUE\",\"filter_inactive_bank_accounts\":\"SOME_BOOLEAN_VALUE\",\"appName\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Bank Account", "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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postBankAccounts" }, "examples": { "Request example": { "value": { "bank_account": { "bank_account_type_id": "string", "ledger_account_id": "string", "nominal_code": 1, "default_payment_method_id": "string", "gifi_code": 1000, "is_active": true, "currency_id": "string", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "address_type_id": "string", "name": "string", "region": "string", "country_group_id": "string", "is_main_address": true }, "main_contact_person": { "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string" }, "journal_code": { "name": "string", "code": "string", "journal_code_type_id": "string", "control_name": "string", "reserved": true } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Bank Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Bank Accounts" ], "operationId": "postBankAccounts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/bank_accounts \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_account\":{\"bank_account_type_id\":\"string\",\"ledger_account_id\":\"string\",\"nominal_code\":1,\"default_payment_method_id\":\"string\",\"gifi_code\":1000,\"is_active\":true,\"currency_id\":\"string\",\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\"},\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_account\":{\"bank_account_type_id\":\"string\",\"ledger_account_id\":\"string\",\"nominal_code\":1,\"default_payment_method_id\":\"string\",\"gifi_code\":1000,\"is_active\":true,\"currency_id\":\"string\",\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\"},\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}}' | \\\n http POST https://api.accounting.sage.com/v3.1/bank_accounts \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_account\":{\"bank_account_type_id\":\"string\",\"ledger_account_id\":\"string\",\"nominal_code\":1,\"default_payment_method_id\":\"string\",\"gifi_code\":1000,\"is_active\":true,\"currency_id\":\"string\",\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\"},\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_accounts", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_account\": {\n \"bank_account_type_id\": \"string\",\n \"ledger_account_id\": \"string\",\n \"nominal_code\": 1,\n \"default_payment_method_id\": \"string\",\n \"gifi_code\": 1000,\n \"is_active\": true,\n \"currency_id\": \"string\",\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": true\n },\n \"main_contact_person\": {\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\"\n },\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": true\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/bank_accounts\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_accounts\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_accounts\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_account: {\n bank_account_type_id: 'string',\n ledger_account_id: 'string',\n nominal_code: 1,\n default_payment_method_id: 'string',\n gifi_code: 1000,\n is_active: true,\n currency_id: 'string',\n bank_account_details: {\n account_name: 'string',\n account_number: 'string',\n sort_code: 'string',\n bic: 'string',\n iban: 'string'\n },\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n address_type_id: 'string',\n name: 'string',\n region: 'string',\n country_group_id: 'string',\n is_main_address: true\n },\n main_contact_person: {\n name: 'string',\n job_title: 'string',\n telephone: 'string',\n mobile: 'string',\n email: 'string',\n fax: 'string'\n },\n journal_code: {\n name: 'string',\n code: 'string',\n journal_code_type_id: 'string',\n control_name: 'string',\n reserved: true\n }\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_accounts\"),\n Content = new StringContent(\"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_accounts\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/bank_accounts\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_accounts\"\n\npayload = {\"bank_account\": {\n \"bank_account_type_id\": \"string\",\n \"ledger_account_id\": \"string\",\n \"nominal_code\": 1,\n \"default_payment_method_id\": \"string\",\n \"gifi_code\": 1000,\n \"is_active\": True,\n \"currency_id\": \"string\",\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": True\n },\n \"main_contact_person\": {\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\"\n },\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": True\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/bank_accounts/{key}": { "get": { "summary": "Returns a Bank Account", "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, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Account Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Bank Account (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Bank Account (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_balance", "description": "Include bank balance of only cleared transactions in the response. Will default to false if value is not set.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Bank Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Bank Accounts" ], "operationId": "getBankAccountsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_accounts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&show_balance=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"show_balance\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Bank Account", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Account Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putBankAccounts" }, "examples": { "Request example": { "value": { "bank_account": { "bank_account_type_id": "string", "ledger_account_id": "string", "nominal_code": 1, "default_payment_method_id": "string", "gifi_code": 1000, "is_active": true, "currency_id": "string", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "address_type_id": "string", "name": "string", "region": "string", "country_group_id": "string", "is_main_address": true }, "main_contact_person": { "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string" }, "journal_code": { "name": "string", "code": "string", "journal_code_type_id": "string", "control_name": "string", "reserved": true } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Bank Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Bank Accounts" ], "operationId": "putBankAccountsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_account\":{\"bank_account_type_id\":\"string\",\"ledger_account_id\":\"string\",\"nominal_code\":1,\"default_payment_method_id\":\"string\",\"gifi_code\":1000,\"is_active\":true,\"currency_id\":\"string\",\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\"},\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_account\":{\"bank_account_type_id\":\"string\",\"ledger_account_id\":\"string\",\"nominal_code\":1,\"default_payment_method_id\":\"string\",\"gifi_code\":1000,\"is_active\":true,\"currency_id\":\"string\",\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\"},\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_account\":{\"bank_account_type_id\":\"string\",\"ledger_account_id\":\"string\",\"nominal_code\":1,\"default_payment_method_id\":\"string\",\"gifi_code\":1000,\"is_active\":true,\"currency_id\":\"string\",\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\"},\"journal_code\":{\"name\":\"string\",\"code\":\"string\",\"journal_code_type_id\":\"string\",\"control_name\":\"string\",\"reserved\":true}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_account\": {\n \"bank_account_type_id\": \"string\",\n \"ledger_account_id\": \"string\",\n \"nominal_code\": 1,\n \"default_payment_method_id\": \"string\",\n \"gifi_code\": 1000,\n \"is_active\": true,\n \"currency_id\": \"string\",\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": true\n },\n \"main_contact_person\": {\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\"\n },\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": true\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_accounts/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_account: {\n bank_account_type_id: 'string',\n ledger_account_id: 'string',\n nominal_code: 1,\n default_payment_method_id: 'string',\n gifi_code: 1000,\n is_active: true,\n currency_id: 'string',\n bank_account_details: {\n account_name: 'string',\n account_number: 'string',\n sort_code: 'string',\n bic: 'string',\n iban: 'string'\n },\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n address_type_id: 'string',\n name: 'string',\n region: 'string',\n country_group_id: 'string',\n is_main_address: true\n },\n main_contact_person: {\n name: 'string',\n job_title: 'string',\n telephone: 'string',\n mobile: 'string',\n email: 'string',\n fax: 'string'\n },\n journal_code: {\n name: 'string',\n code: 'string',\n journal_code_type_id: 'string',\n control_name: 'string',\n reserved: true\n }\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_account\\\":{\\\"bank_account_type_id\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"nominal_code\\\":1,\\\"default_payment_method_id\\\":\\\"string\\\",\\\"gifi_code\\\":1000,\\\"is_active\\\":true,\\\"currency_id\\\":\\\"string\\\",\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\"},\\\"journal_code\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\",\\\"journal_code_type_id\\\":\\\"string\\\",\\\"control_name\\\":\\\"string\\\",\\\"reserved\\\":true}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/bank_accounts/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\"\n\npayload = {\"bank_account\": {\n \"bank_account_type_id\": \"string\",\n \"ledger_account_id\": \"string\",\n \"nominal_code\": 1,\n \"default_payment_method_id\": \"string\",\n \"gifi_code\": 1000,\n \"is_active\": True,\n \"currency_id\": \"string\",\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": True\n },\n \"main_contact_person\": {\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\"\n },\n \"journal_code\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"journal_code_type_id\": \"string\",\n \"control_name\": \"string\",\n \"reserved\": True\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Bank Account", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Account Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Bank Account" } }, "tags": [ "Bank Accounts" ], "operationId": "deleteBankAccountsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_accounts/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/bank_accounts/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/bank_accounts/{key}/bank_feed": { "get": { "summary": "Bank feed endpoint for Banking Cloud Bank accounts", "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, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Account GUID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bank feed endpoint for Banking Cloud Bank accounts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "bank_accounts" ], "operationId": "getBankAccountsKeyBankFeed", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_accounts/%7Bkey%7D/bank_feed\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_accounts/%7Bkey%7D/bank_feed\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_accounts/%7Bkey%7D/bank_feed\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/bank_account_types": { "get": { "summary": "Returns all Bank Account Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Account Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Account Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Account Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Bank Account Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Bank Account Types" ], "operationId": "getBankAccountTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_account_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_account_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/bank_account_types/{key}": { "get": { "summary": "Returns a Bank Account Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Account Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Account Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Bank Account Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Bank Account Types" ], "operationId": "getBankAccountTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_account_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_account_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/bank_deposits": { "get": { "summary": "Returns all Bank Deposits", "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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Deposits 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Deposits 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Deposits dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Deposits dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Deposits per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Deposits", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Deposits (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Bank Deposits", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankDeposit" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "from_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "to_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "date": "2019-08-24", "reference": "string", "cash_amount": 0.1, "cheque_amount": 0.1, "total_amount": 0.1 } ] } } } } } }, "tags": [ "Bank Deposits" ], "operationId": "getBankDeposits", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_deposits?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_deposits\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Bank Deposit", "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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postBankDeposits" }, "examples": { "Request example": { "value": { "bank_deposit": { "from_bank_account_id": "string", "to_bank_account_id": "string", "date": "2019-08-24", "reference": "string", "cash_amount": 0.1, "cheque_amount": 0.1, "total_amount": 0.1 } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Bank Deposit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankDeposit" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "from_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "to_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "date": "2019-08-24", "reference": "string", "cash_amount": 0.1, "cheque_amount": 0.1, "total_amount": 0.1 } } } } } } }, "tags": [ "Bank Deposits" ], "operationId": "postBankDeposits", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/bank_deposits \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_deposit\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"cash_amount\":0.1,\"cheque_amount\":0.1,\"total_amount\":0.1}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_deposit\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"cash_amount\":0.1,\"cheque_amount\":0.1,\"total_amount\":0.1}}' | \\\n http POST https://api.accounting.sage.com/v3.1/bank_deposits \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_deposit\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"cash_amount\":0.1,\"cheque_amount\":0.1,\"total_amount\":0.1}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_deposits", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_deposit\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"cash_amount\": 0.1,\n \"cheque_amount\": 0.1,\n \"total_amount\": 0.1\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/bank_deposits\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_deposits\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_deposits\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_deposit: {\n from_bank_account_id: 'string',\n to_bank_account_id: 'string',\n date: '2019-08-24',\n reference: 'string',\n cash_amount: 0.1,\n cheque_amount: 0.1,\n total_amount: 0.1\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_deposits\"),\n Content = new StringContent(\"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_deposits\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/bank_deposits\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_deposits\"\n\npayload = {\"bank_deposit\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"cash_amount\": 0.1,\n \"cheque_amount\": 0.1,\n \"total_amount\": 0.1\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/bank_deposits \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_deposit\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"cash_amount\":0.1,\"cheque_amount\":0.1,\"total_amount\":0.1}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_deposit\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"cash_amount\":0.1,\"cheque_amount\":0.1,\"total_amount\":0.1}}' | \\\n http POST https://api.accounting.sage.com/v3.1/bank_deposits \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_deposit\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"cash_amount\":0.1,\"cheque_amount\":0.1,\"total_amount\":0.1}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_deposits", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_deposit\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"cash_amount\": 0.1,\n \"cheque_amount\": 0.1,\n \"total_amount\": 0.1\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/bank_deposits\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_deposits\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_deposits\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_deposit: {\n from_bank_account_id: 'string',\n to_bank_account_id: 'string',\n date: '2019-08-24',\n reference: 'string',\n cash_amount: 0.1,\n cheque_amount: 0.1,\n total_amount: 0.1\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_deposits\"),\n Content = new StringContent(\"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_deposits\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_deposit\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"cash_amount\\\":0.1,\\\"cheque_amount\\\":0.1,\\\"total_amount\\\":0.1}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/bank_deposits\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_deposits\"\n\npayload = {\"bank_deposit\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"cash_amount\": 0.1,\n \"cheque_amount\": 0.1,\n \"total_amount\": 0.1\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/bank_deposits/{key}": { "get": { "summary": "Returns a Bank Deposit", "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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Deposit Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Deposit (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Deposit (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Bank Deposit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankDeposit" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "from_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "to_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "date": "2019-08-24", "reference": "string", "cash_amount": 0.1, "cheque_amount": 0.1, "total_amount": 0.1 } } } } } } }, "tags": [ "Bank Deposits" ], "operationId": "getBankDepositsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_deposits/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Bank Deposit", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Deposit Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Bank Deposit" } }, "tags": [ "Bank Deposits" ], "operationId": "deleteBankDepositsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_deposits/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/bank_deposits/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_deposits/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/bank_reconciliations": { "get": { "summary": "Returns all Bank Reconciliations", "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, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Bank Reconciliations 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "bank_account_id", "description": "Use this to filter by bank account id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Bank Reconciliations per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Bank Reconciliations", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Bank Reconciliations (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Bank Reconciliations", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliation" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "statement_date": "2019-08-24", "statement_end_balance": 0.1, "reference": "string", "total_received": 0.1, "total_paid": 0.1, "starting_balance": 0.1, "closing_balance": 0.1, "reconciled_balance": 0.1, "balance_difference": 0.1, "status": { "id": "string", "displayed_as": "string" } } ] } } } } } }, "tags": [ "Bank Reconciliations" ], "operationId": "getBankReconciliations", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_reconciliations?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_reconciliations\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"bank_account_id\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Bank Reconciliation", "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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postBankReconciliations" }, "examples": { "Request example": { "value": { "bank_reconciliation": { "bank_account_id": "string", "statement_date": "2019-08-24", "statement_end_balance": 0.1, "reference": "string", "total_received": 0.1, "total_paid": 0.1, "starting_balance": 0.1, "closing_balance": 0.1, "reconciled_balance": 0.1, "balance_difference": 0.1, "status_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Bank Reconciliation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliation" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "statement_date": "2019-08-24", "statement_end_balance": 0.1, "reference": "string", "total_received": 0.1, "total_paid": 0.1, "starting_balance": 0.1, "closing_balance": 0.1, "reconciled_balance": 0.1, "balance_difference": 0.1, "status": { "id": "string", "displayed_as": "string" } } } } } } } }, "tags": [ "Bank Reconciliations" ], "operationId": "postBankReconciliations", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/bank_reconciliations \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_reconciliation\":{\"bank_account_id\":\"string\",\"statement_date\":\"2019-08-24\",\"statement_end_balance\":0.1,\"reference\":\"string\",\"total_received\":0.1,\"total_paid\":0.1,\"starting_balance\":0.1,\"closing_balance\":0.1,\"reconciled_balance\":0.1,\"balance_difference\":0.1,\"status_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_reconciliation\":{\"bank_account_id\":\"string\",\"statement_date\":\"2019-08-24\",\"statement_end_balance\":0.1,\"reference\":\"string\",\"total_received\":0.1,\"total_paid\":0.1,\"starting_balance\":0.1,\"closing_balance\":0.1,\"reconciled_balance\":0.1,\"balance_difference\":0.1,\"status_id\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/bank_reconciliations \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_reconciliation\":{\"bank_account_id\":\"string\",\"statement_date\":\"2019-08-24\",\"statement_end_balance\":0.1,\"reference\":\"string\",\"total_received\":0.1,\"total_paid\":0.1,\"starting_balance\":0.1,\"closing_balance\":0.1,\"reconciled_balance\":0.1,\"balance_difference\":0.1,\"status_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_reconciliations", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_reconciliation\": {\n \"bank_account_id\": \"string\",\n \"statement_date\": \"2019-08-24\",\n \"statement_end_balance\": 0.1,\n \"reference\": \"string\",\n \"total_received\": 0.1,\n \"total_paid\": 0.1,\n \"starting_balance\": 0.1,\n \"closing_balance\": 0.1,\n \"reconciled_balance\": 0.1,\n \"balance_difference\": 0.1,\n \"status_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/bank_reconciliations\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_reconciliations\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_reconciliations\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_reconciliation: {\n bank_account_id: 'string',\n statement_date: '2019-08-24',\n statement_end_balance: 0.1,\n reference: 'string',\n total_received: 0.1,\n total_paid: 0.1,\n starting_balance: 0.1,\n closing_balance: 0.1,\n reconciled_balance: 0.1,\n balance_difference: 0.1,\n status_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_reconciliations\"),\n Content = new StringContent(\"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_reconciliations\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/bank_reconciliations\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_reconciliations\"\n\npayload = {\"bank_reconciliation\": {\n \"bank_account_id\": \"string\",\n \"statement_date\": \"2019-08-24\",\n \"statement_end_balance\": 0.1,\n \"reference\": \"string\",\n \"total_received\": 0.1,\n \"total_paid\": 0.1,\n \"starting_balance\": 0.1,\n \"closing_balance\": 0.1,\n \"reconciled_balance\": 0.1,\n \"balance_difference\": 0.1,\n \"status_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/bank_reconciliations/{key}": { "get": { "summary": "Returns a Bank Reconciliation", "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, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Reconciliation Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Bank Reconciliation (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Bank Reconciliation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliation" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "statement_date": "2019-08-24", "statement_end_balance": 0.1, "reference": "string", "total_received": 0.1, "total_paid": 0.1, "starting_balance": 0.1, "closing_balance": 0.1, "reconciled_balance": 0.1, "balance_difference": 0.1, "status": { "id": "string", "displayed_as": "string" } } } } } } } }, "tags": [ "Bank Reconciliations" ], "operationId": "getBankReconciliationsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_reconciliations/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Bank Reconciliation", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Reconciliation Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putBankReconciliations" }, "examples": { "Request example": { "value": { "bank_reconciliation": { "bank_account_id": "string", "statement_date": "2019-08-24", "statement_end_balance": 0.1, "reference": "string", "total_received": 0.1, "total_paid": 0.1, "starting_balance": 0.1, "closing_balance": 0.1, "reconciled_balance": 0.1, "balance_difference": 0.1, "status_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Bank Reconciliation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliation" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "statement_date": "2019-08-24", "statement_end_balance": 0.1, "reference": "string", "total_received": 0.1, "total_paid": 0.1, "starting_balance": 0.1, "closing_balance": 0.1, "reconciled_balance": 0.1, "balance_difference": 0.1, "status": { "id": "string", "displayed_as": "string" } } } } } } } }, "tags": [ "Bank Reconciliations" ], "operationId": "putBankReconciliationsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_reconciliation\":{\"bank_account_id\":\"string\",\"statement_date\":\"2019-08-24\",\"statement_end_balance\":0.1,\"reference\":\"string\",\"total_received\":0.1,\"total_paid\":0.1,\"starting_balance\":0.1,\"closing_balance\":0.1,\"reconciled_balance\":0.1,\"balance_difference\":0.1,\"status_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_reconciliation\":{\"bank_account_id\":\"string\",\"statement_date\":\"2019-08-24\",\"statement_end_balance\":0.1,\"reference\":\"string\",\"total_received\":0.1,\"total_paid\":0.1,\"starting_balance\":0.1,\"closing_balance\":0.1,\"reconciled_balance\":0.1,\"balance_difference\":0.1,\"status_id\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_reconciliation\":{\"bank_account_id\":\"string\",\"statement_date\":\"2019-08-24\",\"statement_end_balance\":0.1,\"reference\":\"string\",\"total_received\":0.1,\"total_paid\":0.1,\"starting_balance\":0.1,\"closing_balance\":0.1,\"reconciled_balance\":0.1,\"balance_difference\":0.1,\"status_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_reconciliation\": {\n \"bank_account_id\": \"string\",\n \"statement_date\": \"2019-08-24\",\n \"statement_end_balance\": 0.1,\n \"reference\": \"string\",\n \"total_received\": 0.1,\n \"total_paid\": 0.1,\n \"starting_balance\": 0.1,\n \"closing_balance\": 0.1,\n \"reconciled_balance\": 0.1,\n \"balance_difference\": 0.1,\n \"status_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_reconciliations/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_reconciliation: {\n bank_account_id: 'string',\n statement_date: '2019-08-24',\n statement_end_balance: 0.1,\n reference: 'string',\n total_received: 0.1,\n total_paid: 0.1,\n starting_balance: 0.1,\n closing_balance: 0.1,\n reconciled_balance: 0.1,\n balance_difference: 0.1,\n status_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_reconciliation\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"statement_date\\\":\\\"2019-08-24\\\",\\\"statement_end_balance\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"total_received\\\":0.1,\\\"total_paid\\\":0.1,\\\"starting_balance\\\":0.1,\\\"closing_balance\\\":0.1,\\\"reconciled_balance\\\":0.1,\\\"balance_difference\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/bank_reconciliations/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_reconciliations/%7Bkey%7D\"\n\npayload = {\"bank_reconciliation\": {\n \"bank_account_id\": \"string\",\n \"statement_date\": \"2019-08-24\",\n \"statement_end_balance\": 0.1,\n \"reference\": \"string\",\n \"total_received\": 0.1,\n \"total_paid\": 0.1,\n \"starting_balance\": 0.1,\n \"closing_balance\": 0.1,\n \"reconciled_balance\": 0.1,\n \"balance_difference\": 0.1,\n \"status_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/bank_transfers": { "get": { "summary": "Returns all Bank Transfers", "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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Bank Transfers dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Bank Transfers dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Bank Transfers per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Bank Transfers", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "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)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Bank Transfers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransfer" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "from_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "to_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "date": "2019-08-24", "reference": "string", "amount": 0.1, "description": "string" } ] } } } } } }, "tags": [ "Bank Transfers" ], "operationId": "getBankTransfers", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_transfers?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_transfers\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a 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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postBankTransfers" }, "examples": { "Request example": { "value": { "bank_transfer": { "from_bank_account_id": "string", "to_bank_account_id": "string", "date": "2019-08-24", "amount": 0.1, "reference": "string", "description": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Bank Transfer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransfer" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "from_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "to_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "date": "2019-08-24", "reference": "string", "amount": 0.1, "description": "string" } } } } } } }, "tags": [ "Bank Transfers" ], "operationId": "postBankTransfers", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/bank_transfers \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_transfer\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"amount\":0.1,\"reference\":\"string\",\"description\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_transfer\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"amount\":0.1,\"reference\":\"string\",\"description\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/bank_transfers \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_transfer\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"amount\":0.1,\"reference\":\"string\",\"description\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_transfers", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_transfer\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"amount\": 0.1,\n \"reference\": \"string\",\n \"description\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/bank_transfers\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_transfers\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_transfers\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_transfer: {\n from_bank_account_id: 'string',\n to_bank_account_id: 'string',\n date: '2019-08-24',\n amount: 0.1,\n reference: 'string',\n description: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_transfers\"),\n Content = new StringContent(\"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_transfers\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/bank_transfers\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_transfers\"\n\npayload = {\"bank_transfer\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"amount\": 0.1,\n \"reference\": \"string\",\n \"description\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/bank_transfers/{key}": { "get": { "summary": "Returns a 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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Transfer Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Bank Transfer (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Bank Transfer (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Bank Transfer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransfer" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "from_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "to_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "date": "2019-08-24", "reference": "string", "amount": 0.1, "description": "string" } } } } } } }, "tags": [ "Bank Transfers" ], "operationId": "getBankTransfersKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_transfers/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a 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", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Transfer Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putBankTransfers" }, "examples": { "Request example": { "value": { "bank_transfer": { "from_bank_account_id": "string", "to_bank_account_id": "string", "date": "2019-08-24", "amount": 0.1, "reference": "string", "description": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Bank Transfer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransfer" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "from_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "to_bank_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "balance": 0.1, "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "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": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "code": "string", "journal_code_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "control_name": "string", "reserved": true }, "default_payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "gifi_code": 0, "is_active": true, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } }, "date": "2019-08-24", "reference": "string", "amount": 0.1, "description": "string" } } } } } } }, "tags": [ "Bank Transfers" ], "operationId": "putBankTransfersKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_transfer\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"amount\":0.1,\"reference\":\"string\",\"description\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_transfer\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"amount\":0.1,\"reference\":\"string\",\"description\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_transfer\":{\"from_bank_account_id\":\"string\",\"to_bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"amount\":0.1,\"reference\":\"string\",\"description\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_transfer\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"amount\": 0.1,\n \"reference\": \"string\",\n \"description\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_transfers/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_transfer: {\n from_bank_account_id: 'string',\n to_bank_account_id: 'string',\n date: '2019-08-24',\n amount: 0.1,\n reference: 'string',\n description: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_transfer\\\":{\\\"from_bank_account_id\\\":\\\"string\\\",\\\"to_bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/bank_transfers/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\"\n\npayload = {\"bank_transfer\": {\n \"from_bank_account_id\": \"string\",\n \"to_bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"amount\": 0.1,\n \"reference\": \"string\",\n \"description\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a 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", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Transfer Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Bank Transfer" } }, "tags": [ "Bank Transfers" ], "operationId": "deleteBankTransfersKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_transfers/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/bank_transfers/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_transfers/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/addresses": { "get": { "summary": "Returns all Addresses", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "bank_account_id", "description": "Use this to filter by bank account id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Addresses 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Addresses 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Addresses per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Addresses", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Addresses (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Addresses", "content": { "application/json": { "examples": { "response": { "value": { "$total": 236, "$page": 1, "$next": "/addresses?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "58ff84d719cf45b5bcf17c033ea713d3", "displayed_as": "United Kingdom", "$path": "/addresses/58ff84d719cf45b5bcf17c033ea713d3" }, { "id": "20561be8a9d845d1ab454dae15016ded", "displayed_as": "United Kingdom", "$path": "/addresses/20561be8a9d845d1ab454dae15016ded" }, { "id": "81c534e826884c178167fc55e1e9cc60", "displayed_as": "", "$path": "/addresses/81c534e826884c178167fc55e1e9cc60" }, { "id": "81dff3aa23b64034a403c2d5fa48c61e", "displayed_as": "", "$path": "/addresses/81dff3aa23b64034a403c2d5fa48c61e" }, { "id": "90234c75a8d54a91bc81320ee3ae5d0d", "displayed_as": "United Kingdom", "$path": "/addresses/90234c75a8d54a91bc81320ee3ae5d0d" }, { "id": "c8f6c652dceb4ab9a224533a91f014a4", "displayed_as": "United Kingdom", "$path": "/addresses/c8f6c652dceb4ab9a224533a91f014a4" }, { "id": "f5fd5573a18e487499778f3d46ab6160", "displayed_as": "United Kingdom", "$path": "/addresses/f5fd5573a18e487499778f3d46ab6160" }, { "id": "7c19fc6859b345f0800a365dfe810cd4", "displayed_as": "United Kingdom", "$path": "/addresses/7c19fc6859b345f0800a365dfe810cd4" }, { "id": "34f1e571cac34da7b2c0dfe65042c987", "displayed_as": "United Kingdom", "$path": "/addresses/34f1e571cac34da7b2c0dfe65042c987" }, { "id": "ee872f7bad3d4fed959b480b16bde859", "displayed_as": "United Kingdom", "$path": "/addresses/ee872f7bad3d4fed959b480b16bde859" } ] } } } } } } }, "tags": [ "Addresses" ], "operationId": "getAddresses", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/addresses?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/addresses\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"bank_account_id\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Address", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postAddresses" }, "examples": { "Request example": { "value": { "address": { "address_type_id": "string", "name": "string", "is_main_address": true, "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "region": "string", "country_group_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true } } } } } } }, "tags": [ "Addresses" ], "operationId": "postAddresses", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/addresses \\\n --header 'Content-Type: application/json' \\\n --data '{\"address\":{\"address_type_id\":\"string\",\"name\":\"string\",\"is_main_address\":true,\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"address\":{\"address_type_id\":\"string\",\"name\":\"string\",\"is_main_address\":true,\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/addresses \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"address\":{\"address_type_id\":\"string\",\"name\":\"string\",\"is_main_address\":true,\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/addresses", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"address\": {\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"is_main_address\": true,\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/addresses\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/addresses\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/addresses\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n address: {\n address_type_id: 'string',\n name: 'string',\n is_main_address: true,\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n region: 'string',\n country_group_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/addresses\"),\n Content = new StringContent(\"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/addresses\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/addresses\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/addresses\"\n\npayload = {\"address\": {\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"is_main_address\": True,\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/addresses/{key}": { "get": { "summary": "Returns a Address", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access\n* Area: `Bank`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Address Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Address (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Address (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an Address", "content": { "application/json": { "examples": { "response": { "value": { "id": "20561be8a9d845d1ab454dae15016ded", "displayed_as": "United Kingdom", "$path": "/addresses/20561be8a9d845d1ab454dae15016ded", "address_line_1": null, "address_line_2": null, "city": null, "postal_code": null, "country": { "id": "GB", "displayed_as": "United Kingdom (GB)", "$path": "/countries/GB" }, "created_at": "2022-12-30T13:54:24Z", "updated_at": "2022-12-30T13:54:24Z", "bank_account": { "id": "4ad5a004af3d463fa1c1179f8d821ad3", "displayed_as": "Cash (1210)", "$path": "/bank_accounts/4ad5a004af3d463fa1c1179f8d821ad3" }, "address_type": { "id": "DELIVERY", "displayed_as": "Delivery", "$path": "/address_types/DELIVERY" }, "name": "Main Address", "region": null, "country_group": { "id": "GBIE", "displayed_as": "UK & Ireland", "$path": "/country_groups/GBIE" }, "is_main_address": true } } } } } } }, "tags": [ "Addresses" ], "operationId": "getAddressesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/addresses/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Address", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Address Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putAddresses" }, "examples": { "Request example": { "value": { "address": { "address_type_id": "string", "name": "string", "is_main_address": true, "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "region": "string", "country_group_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true } } } } } } }, "tags": [ "Addresses" ], "operationId": "putAddressesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"address\":{\"address_type_id\":\"string\",\"name\":\"string\",\"is_main_address\":true,\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"address\":{\"address_type_id\":\"string\",\"name\":\"string\",\"is_main_address\":true,\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"address\":{\"address_type_id\":\"string\",\"name\":\"string\",\"is_main_address\":true,\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"address\": {\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"is_main_address\": true,\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/addresses/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n address: {\n address_type_id: 'string',\n name: 'string',\n is_main_address: true,\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n region: 'string',\n country_group_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"address\\\":{\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"is_main_address\\\":true,\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/addresses/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\"\n\npayload = {\"address\": {\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"is_main_address\": True,\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Address", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Address Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Address" } }, "tags": [ "Addresses" ], "operationId": "deleteAddressesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/addresses/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/addresses/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/addresses/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/address_types": { "get": { "summary": "Returns all Address Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Address Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Address Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Address Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Address Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 4, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "DELIVERY", "displayed_as": "Delivery", "$path": "/address_types/DELIVERY" }, { "id": "ACCOUNTS", "displayed_as": "Accounts", "$path": "/address_types/ACCOUNTS" }, { "id": "SALES", "displayed_as": "Sales", "$path": "/address_types/SALES" }, { "id": "PURCHASING", "displayed_as": "Purchasing", "$path": "/address_types/PURCHASING" } ] } } } } } } }, "tags": [ "Address Types" ], "operationId": "getAddressTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/address_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/address_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/address_types/{key}": { "get": { "summary": "Returns a Address Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Address Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Address Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Address Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "ACCOUNTS", "displayed_as": "Accounts", "$path": "/address_types/ACCOUNTS" } } } } } } }, "tags": [ "Address Types" ], "operationId": "getAddressTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/address_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/address_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/address_regions": { "get": { "summary": "Returns all Address Regions", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of States per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of States", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the States (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "country_id", "description": "Use this to filter by country id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Address Regions", "content": { "application/json": { "examples": { "response": { "value": { "$total": 72, "$page": 1, "$next": "/address_regions?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "CA-AB", "displayed_as": "Alberta (AB)", "$path": "/address_regions/CA-AB" }, { "id": "CA-BC", "displayed_as": "British Columbia (BC)", "$path": "/address_regions/CA-BC" }, { "id": "CA-MB", "displayed_as": "Manitoba (MB)", "$path": "/address_regions/CA-MB" }, { "id": "CA-NB", "displayed_as": "New Brunswick (NB)", "$path": "/address_regions/CA-NB" }, { "id": "CA-NL", "displayed_as": "Newfoundland and Labrador (NL)", "$path": "/address_regions/CA-NL" }, { "id": "CA-NS", "displayed_as": "Nova Scotia (NS)", "$path": "/address_regions/CA-NS" }, { "id": "CA-NT", "displayed_as": "Northwest Territories (NT)", "$path": "/address_regions/CA-NT" }, { "id": "CA-NU", "displayed_as": "Nunavut (NU)", "$path": "/address_regions/CA-NU" }, { "id": "CA-ON", "displayed_as": "Ontario (ON)", "$path": "/address_regions/CA-ON" }, { "id": "CA-PE", "displayed_as": "Prince Edward Island (PE)", "$path": "/address_regions/CA-PE" } ] } } } } } } }, "tags": [ "Address Regions" ], "operationId": "getAddressRegions", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/address_regions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&country_id=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/address_regions\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"country_id\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/address_regions/{key}": { "get": { "summary": "Returns a Address Region", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Address Region Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the State (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Address Region", "content": { "application/json": { "examples": { "response": { "value": { "id": "CA-AB", "displayed_as": "Alberta (AB)", "$path": "/address_regions/CA-AB", "code": "AB", "name": "Alberta" } } } } } } }, "tags": [ "Address Regions" ], "operationId": "getAddressRegionsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/address_regions/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/address_regions/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contacts": { "get": { "summary": "Returns all Contacts", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Contacts 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "contact_type_id", "description": "Use this to filter by contact type id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "exclude_system", "description": "Use this to filter out system entities, not applicable for transaction creation", "required": false, "schema": { "type": "boolean" } }, { "name": "home_contacts_only", "in": "query", "description": "Use this to filter the response for contacts with the same country as the business.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Contacts (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_balance", "description": "Use this to display the balance for a contact.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "context_date", "description": "Use this to determine the correct tax treatment for a contact on a given date.", "required": false, "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "search", "description": "Use this to filter by the contact name, company name or reference.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "email", "description": "Use this to filter by the contact person email address.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_unfinished_recurring_invoices_status", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "filter_inactive_contacts", "description": "Use this to filter inactive contacts", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Contacts per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Contacts", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Contacts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contacts", "content": { "application/json": { "examples": { "response": { "value": { "$total": 148, "$page": 1, "$next": "/contacts?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "bd7860529a6445f7898b4418feced4b1", "displayed_as": "HMRC Reclaimed (HMRC Rec)", "$path": "/contacts/bd7860529a6445f7898b4418feced4b1" }, { "id": "eaab22cbff1e4f33883fa39961124ac7", "displayed_as": "HMRC Payments (HMRC Pay)", "$path": "/contacts/eaab22cbff1e4f33883fa39961124ac7" }, { "id": "b274fd7f50f8413b8e375795c81b9594", "displayed_as": "Windsor (A1D001)", "$path": "/contacts/b274fd7f50f8413b8e375795c81b9594" }, { "id": "521229b29af04f3682d85b0d43ef5361", "displayed_as": "ABS Garages Ltd (ABS001)", "$path": "/contacts/521229b29af04f3682d85b0d43ef5361" }, { "id": "cced5085c2d24394a758c5d16b38fca1", "displayed_as": "Bobs Building Supplies (BBS001)", "$path": "/contacts/cced5085c2d24394a758c5d16b38fca1" }, { "id": "607808ff4c694521a45b279e4cdd78a0", "displayed_as": "Fred Briant (BRI001)", "$path": "/contacts/607808ff4c694521a45b279e4cdd78a0" }, { "id": "81320fdb3dca461eac4f7942604c2f38", "displayed_as": "Bronson Inc (BRO001)", "$path": "/contacts/81320fdb3dca461eac4f7942604c2f38" }, { "id": "9e2f8d3d7e0d48b39648227962cfb6cb", "displayed_as": "Business Exhibitions (BUS001)", "$path": "/contacts/9e2f8d3d7e0d48b39648227962cfb6cb" }, { "id": "bfc881c9b12546458d891e97621982aa", "displayed_as": "Cash and Credit Card Sales (CASH001)", "$path": "/contacts/bfc881c9b12546458d891e97621982aa" }, { "id": "b38722cd2ae14b69b4aa506e819ce041", "displayed_as": "County Golf Supplies (CGS001)", "$path": "/contacts/b38722cd2ae14b69b4aa506e819ce041" } ] } } } } } } }, "tags": [ "Contacts" ], "operationId": "getContacts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contacts?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&exclude_system=SOME_BOOLEAN_VALUE&home_contacts_only=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&search=SOME_STRING_VALUE&email=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&filter_inactive_contacts=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contacts\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"contact_type_id\":\"SOME_STRING_VALUE\",\"exclude_system\":\"SOME_BOOLEAN_VALUE\",\"home_contacts_only\":\"SOME_BOOLEAN_VALUE\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_balance\":\"SOME_BOOLEAN_VALUE\",\"context_date\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"email\":\"SOME_STRING_VALUE\",\"show_unfinished_recurring_invoices_status\":\"SOME_BOOLEAN_VALUE\",\"filter_inactive_contacts\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Contact", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postContacts" }, "examples": { "Request example": { "value": { "contact": { "name": "string", "contact_type_ids": [ "string" ], "reference": "string", "default_sales_ledger_account_id": "string", "default_sales_tax_rate_id": "string", "default_purchase_ledger_account_id": "string", "tax_number": "string", "notes": "string", "locale": "string", "credit_limit": 0.1, "credit_days": 365, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type_id": "string", "source_guid": "string", "currency_id": "string", "aux_reference": "string", "registered_number": "string", "tax_calculation": "string", "auxiliary_account": "string", "destination_vat_blocking": true, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "address_type_id": "string", "name": "string", "region": "string", "country_group_id": "string", "is_main_address": true }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "address_type_id": "string", "name": "string", "region": "string", "country_group_id": "string", "is_main_address": true }, "main_contact_person": { "contact_person_type_ids": [ "string" ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address_id": "string", "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true } } } } } } }, "tags": [ "Contacts" ], "operationId": "postContacts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/contacts \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact\":{\"name\":\"string\",\"contact_type_ids\":[\"string\"],\"reference\":\"string\",\"default_sales_ledger_account_id\":\"string\",\"default_sales_tax_rate_id\":\"string\",\"default_purchase_ledger_account_id\":\"string\",\"tax_number\":\"string\",\"notes\":\"string\",\"locale\":\"string\",\"credit_limit\":0.1,\"credit_days\":365,\"credit_terms\":\"month_end_invoice\",\"credit_terms_and_conditions\":\"string\",\"product_sales_price_type_id\":\"string\",\"source_guid\":\"string\",\"currency_id\":\"string\",\"aux_reference\":\"string\",\"registered_number\":\"string\",\"tax_calculation\":\"string\",\"auxiliary_account\":\"string\",\"destination_vat_blocking\":true,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"contact_person_type_ids\":[\"string\"],\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"address_id\":\"string\",\"is_preferred_contact\":true},\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"tax_treatment\":{\"home_tax\":true,\"eu_tax_registered\":true,\"eu_not_tax_registered\":true,\"rest_of_world_tax\":true,\"is_importer\":true}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact\":{\"name\":\"string\",\"contact_type_ids\":[\"string\"],\"reference\":\"string\",\"default_sales_ledger_account_id\":\"string\",\"default_sales_tax_rate_id\":\"string\",\"default_purchase_ledger_account_id\":\"string\",\"tax_number\":\"string\",\"notes\":\"string\",\"locale\":\"string\",\"credit_limit\":0.1,\"credit_days\":365,\"credit_terms\":\"month_end_invoice\",\"credit_terms_and_conditions\":\"string\",\"product_sales_price_type_id\":\"string\",\"source_guid\":\"string\",\"currency_id\":\"string\",\"aux_reference\":\"string\",\"registered_number\":\"string\",\"tax_calculation\":\"string\",\"auxiliary_account\":\"string\",\"destination_vat_blocking\":true,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"contact_person_type_ids\":[\"string\"],\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"address_id\":\"string\",\"is_preferred_contact\":true},\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"tax_treatment\":{\"home_tax\":true,\"eu_tax_registered\":true,\"eu_not_tax_registered\":true,\"rest_of_world_tax\":true,\"is_importer\":true}}}' | \\\n http POST https://api.accounting.sage.com/v3.1/contacts \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact\":{\"name\":\"string\",\"contact_type_ids\":[\"string\"],\"reference\":\"string\",\"default_sales_ledger_account_id\":\"string\",\"default_sales_tax_rate_id\":\"string\",\"default_purchase_ledger_account_id\":\"string\",\"tax_number\":\"string\",\"notes\":\"string\",\"locale\":\"string\",\"credit_limit\":0.1,\"credit_days\":365,\"credit_terms\":\"month_end_invoice\",\"credit_terms_and_conditions\":\"string\",\"product_sales_price_type_id\":\"string\",\"source_guid\":\"string\",\"currency_id\":\"string\",\"aux_reference\":\"string\",\"registered_number\":\"string\",\"tax_calculation\":\"string\",\"auxiliary_account\":\"string\",\"destination_vat_blocking\":true,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"contact_person_type_ids\":[\"string\"],\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"address_id\":\"string\",\"is_preferred_contact\":true},\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"tax_treatment\":{\"home_tax\":true,\"eu_tax_registered\":true,\"eu_not_tax_registered\":true,\"rest_of_world_tax\":true,\"is_importer\":true}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contacts", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact\": {\n \"name\": \"string\",\n \"contact_type_ids\": [\n \"string\"\n ],\n \"reference\": \"string\",\n \"default_sales_ledger_account_id\": \"string\",\n \"default_sales_tax_rate_id\": \"string\",\n \"default_purchase_ledger_account_id\": \"string\",\n \"tax_number\": \"string\",\n \"notes\": \"string\",\n \"locale\": \"string\",\n \"credit_limit\": 0.1,\n \"credit_days\": 365,\n \"credit_terms\": \"month_end_invoice\",\n \"credit_terms_and_conditions\": \"string\",\n \"product_sales_price_type_id\": \"string\",\n \"source_guid\": \"string\",\n \"currency_id\": \"string\",\n \"aux_reference\": \"string\",\n \"registered_number\": \"string\",\n \"tax_calculation\": \"string\",\n \"auxiliary_account\": \"string\",\n \"destination_vat_blocking\": true,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": true\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": true\n },\n \"main_contact_person\": {\n \"contact_person_type_ids\": [\n \"string\"\n ],\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": true,\n \"address_id\": \"string\",\n \"is_preferred_contact\": true\n },\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"tax_treatment\": {\n \"home_tax\": true,\n \"eu_tax_registered\": true,\n \"eu_not_tax_registered\": true,\n \"rest_of_world_tax\": true,\n \"is_importer\": true\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/contacts\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contacts\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contacts\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact: {\n name: 'string',\n contact_type_ids: ['string'],\n reference: 'string',\n default_sales_ledger_account_id: 'string',\n default_sales_tax_rate_id: 'string',\n default_purchase_ledger_account_id: 'string',\n tax_number: 'string',\n notes: 'string',\n locale: 'string',\n credit_limit: 0.1,\n credit_days: 365,\n credit_terms: 'month_end_invoice',\n credit_terms_and_conditions: 'string',\n product_sales_price_type_id: 'string',\n source_guid: 'string',\n currency_id: 'string',\n aux_reference: 'string',\n registered_number: 'string',\n tax_calculation: 'string',\n auxiliary_account: 'string',\n destination_vat_blocking: true,\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n address_type_id: 'string',\n name: 'string',\n region: 'string',\n country_group_id: 'string',\n is_main_address: true\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n address_type_id: 'string',\n name: 'string',\n region: 'string',\n country_group_id: 'string',\n is_main_address: true\n },\n main_contact_person: {\n contact_person_type_ids: ['string'],\n name: 'string',\n job_title: 'string',\n telephone: 'string',\n mobile: 'string',\n email: 'string',\n fax: 'string',\n is_main_contact: true,\n address_id: 'string',\n is_preferred_contact: true\n },\n bank_account_details: {\n account_name: 'string',\n account_number: 'string',\n sort_code: 'string',\n bic: 'string',\n iban: 'string'\n },\n tax_treatment: {\n home_tax: true,\n eu_tax_registered: true,\n eu_not_tax_registered: true,\n rest_of_world_tax: true,\n is_importer: true\n }\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contacts\"),\n Content = new StringContent(\"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contacts\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/contacts\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contacts\"\n\npayload = {\"contact\": {\n \"name\": \"string\",\n \"contact_type_ids\": [\"string\"],\n \"reference\": \"string\",\n \"default_sales_ledger_account_id\": \"string\",\n \"default_sales_tax_rate_id\": \"string\",\n \"default_purchase_ledger_account_id\": \"string\",\n \"tax_number\": \"string\",\n \"notes\": \"string\",\n \"locale\": \"string\",\n \"credit_limit\": 0.1,\n \"credit_days\": 365,\n \"credit_terms\": \"month_end_invoice\",\n \"credit_terms_and_conditions\": \"string\",\n \"product_sales_price_type_id\": \"string\",\n \"source_guid\": \"string\",\n \"currency_id\": \"string\",\n \"aux_reference\": \"string\",\n \"registered_number\": \"string\",\n \"tax_calculation\": \"string\",\n \"auxiliary_account\": \"string\",\n \"destination_vat_blocking\": True,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": True\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": True\n },\n \"main_contact_person\": {\n \"contact_person_type_ids\": [\"string\"],\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": True,\n \"address_id\": \"string\",\n \"is_preferred_contact\": True\n },\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"tax_treatment\": {\n \"home_tax\": True,\n \"eu_tax_registered\": True,\n \"eu_not_tax_registered\": True,\n \"rest_of_world_tax\": True,\n \"is_importer\": True\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/contacts/{key}": { "get": { "summary": "Returns a Contact", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access\n* Area: `Bank`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Contact (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_balance", "description": "Use this to display the balance for a contact.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "context_date", "description": "Use this to determine the correct tax treatment for a contact on a given date.", "required": false, "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "show_unfinished_recurring_invoices_status", "required": false, "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Contact (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact", "content": { "application/json": { "examples": { "response": { "value": { "id": "cced5085c2d24394a758c5d16b38fca1", "displayed_as": "Bobs Building Supplies (BBS001)", "$path": "/contacts/cced5085c2d24394a758c5d16b38fca1", "created_at": "2022-12-30T13:59:24Z", "updated_at": "2023-06-13T10:40:55Z", "links": [ { "href": "https://accounts-extra.sageone.com/contacts/customers/130175300", "rel": "alternate", "type": "text/html" } ], "contact_types": [ { "id": "CUSTOMER", "displayed_as": "Customer", "$path": "/contact_types/CUSTOMER" } ], "name": "Bobs Building Supplies", "reference": "BBS001", "default_sales_ledger_account": { "id": "7a5ecfcf884911ed84fa0252b90cda0d", "displayed_as": "Other income (4900)", "$path": "/ledger_accounts/7a5ecfcf884911ed84fa0252b90cda0d" }, "default_sales_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "tax_number": "GB938484382", "notes": "", "locale": "en", "main_address": { "id": "1a3b9bdf20a64df1a8657715788132f6", "displayed_as": "12", "$path": "/addresses/1a3b9bdf20a64df1a8657715788132f6" }, "preferred_address": { "id": "1a3b9bdf20a64df1a8657715788132f6", "displayed_as": "12", "$path": "/addresses/1a3b9bdf20a64df1a8657715788132f6" }, "delivery_address": null, "main_contact_person": { "id": "da05f391a75241f987eefa1ef227e6ca", "displayed_as": "Main Contact", "$path": "/contact_persons/da05f391a75241f987eefa1ef227e6ca" }, "preferred_contact_person": { "id": "da05f391a75241f987eefa1ef227e6ca", "displayed_as": "Main Contact", "$path": "/contact_persons/da05f391a75241f987eefa1ef227e6ca" }, "bank_account_details": { "account_name": null, "account_number": null, "sort_code": null, "bic": null, "iban": null }, "credit_limit": "2000.0", "credit_days": 30, "credit_terms": null, "credit_terms_and_conditions": "null", "product_sales_price_type": { "id": "26024c3e7357462897edb896cc7084e9", "displayed_as": "Sales Price", "$path": "/product_sales_price_types/26024c3e7357462897edb896cc7084e9" }, "source_guid": "5", "currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "registered_number": null, "deletable": false, "tax_treatment": { "home_tax": true, "eu_tax_registered": false, "eu_not_tax_registered": false, "rest_of_world_tax": false, "is_importer": null }, "email": null, "tax_calculation": "", "gdpr_obfuscated": false, "system": false, "has_unfinished_recurring_invoices": false, "cis_registered": false, "ni_based": false, "is_active": true, "gb_based": true, "cis_settings": null, "destination_vat_blocking": false, "mandate_active": false, "send_statements": true, "statement_run": { "id": "statement_delivery_method_print", "name": "By post (PDF Generated)" }, "go_cardless_mandate": null } } } } } } }, "tags": [ "Contacts" ], "operationId": "getContactsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contacts/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_balance=SOME_BOOLEAN_VALUE&context_date=SOME_STRING_VALUE&show_unfinished_recurring_invoices_status=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_balance\":\"SOME_BOOLEAN_VALUE\",\"context_date\":\"SOME_STRING_VALUE\",\"show_unfinished_recurring_invoices_status\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Contact", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putContacts" }, "examples": { "Request example": { "value": { "contact": { "name": "string", "contact_type_ids": [ "string" ], "reference": "string", "default_sales_ledger_account_id": "string", "default_sales_tax_rate_id": "string", "default_purchase_ledger_account_id": "string", "tax_number": "string", "notes": "string", "locale": "string", "credit_limit": 0.1, "credit_days": 365, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type_id": "string", "source_guid": "string", "currency_id": "string", "aux_reference": "string", "registered_number": "string", "tax_calculation": "string", "auxiliary_account": "string", "destination_vat_blocking": true, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "address_type_id": "string", "name": "string", "region": "string", "country_group_id": "string", "is_main_address": true }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "bank_account_id": "string", "contact_id": "string", "address_type_id": "string", "name": "string", "region": "string", "country_group_id": "string", "is_main_address": true }, "main_contact_person": { "contact_person_type_ids": [ "string" ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address_id": "string", "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true } } } } } } }, "tags": [ "Contacts" ], "operationId": "putContactsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact\":{\"name\":\"string\",\"contact_type_ids\":[\"string\"],\"reference\":\"string\",\"default_sales_ledger_account_id\":\"string\",\"default_sales_tax_rate_id\":\"string\",\"default_purchase_ledger_account_id\":\"string\",\"tax_number\":\"string\",\"notes\":\"string\",\"locale\":\"string\",\"credit_limit\":0.1,\"credit_days\":365,\"credit_terms\":\"month_end_invoice\",\"credit_terms_and_conditions\":\"string\",\"product_sales_price_type_id\":\"string\",\"source_guid\":\"string\",\"currency_id\":\"string\",\"aux_reference\":\"string\",\"registered_number\":\"string\",\"tax_calculation\":\"string\",\"auxiliary_account\":\"string\",\"destination_vat_blocking\":true,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"contact_person_type_ids\":[\"string\"],\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"address_id\":\"string\",\"is_preferred_contact\":true},\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"tax_treatment\":{\"home_tax\":true,\"eu_tax_registered\":true,\"eu_not_tax_registered\":true,\"rest_of_world_tax\":true,\"is_importer\":true}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact\":{\"name\":\"string\",\"contact_type_ids\":[\"string\"],\"reference\":\"string\",\"default_sales_ledger_account_id\":\"string\",\"default_sales_tax_rate_id\":\"string\",\"default_purchase_ledger_account_id\":\"string\",\"tax_number\":\"string\",\"notes\":\"string\",\"locale\":\"string\",\"credit_limit\":0.1,\"credit_days\":365,\"credit_terms\":\"month_end_invoice\",\"credit_terms_and_conditions\":\"string\",\"product_sales_price_type_id\":\"string\",\"source_guid\":\"string\",\"currency_id\":\"string\",\"aux_reference\":\"string\",\"registered_number\":\"string\",\"tax_calculation\":\"string\",\"auxiliary_account\":\"string\",\"destination_vat_blocking\":true,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"contact_person_type_ids\":[\"string\"],\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"address_id\":\"string\",\"is_preferred_contact\":true},\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"tax_treatment\":{\"home_tax\":true,\"eu_tax_registered\":true,\"eu_not_tax_registered\":true,\"rest_of_world_tax\":true,\"is_importer\":true}}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact\":{\"name\":\"string\",\"contact_type_ids\":[\"string\"],\"reference\":\"string\",\"default_sales_ledger_account_id\":\"string\",\"default_sales_tax_rate_id\":\"string\",\"default_purchase_ledger_account_id\":\"string\",\"tax_number\":\"string\",\"notes\":\"string\",\"locale\":\"string\",\"credit_limit\":0.1,\"credit_days\":365,\"credit_terms\":\"month_end_invoice\",\"credit_terms_and_conditions\":\"string\",\"product_sales_price_type_id\":\"string\",\"source_guid\":\"string\",\"currency_id\":\"string\",\"aux_reference\":\"string\",\"registered_number\":\"string\",\"tax_calculation\":\"string\",\"auxiliary_account\":\"string\",\"destination_vat_blocking\":true,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"bank_account_id\":\"string\",\"contact_id\":\"string\",\"address_type_id\":\"string\",\"name\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\",\"is_main_address\":true},\"main_contact_person\":{\"contact_person_type_ids\":[\"string\"],\"name\":\"string\",\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"address_id\":\"string\",\"is_preferred_contact\":true},\"bank_account_details\":{\"account_name\":\"string\",\"account_number\":\"string\",\"sort_code\":\"string\",\"bic\":\"string\",\"iban\":\"string\"},\"tax_treatment\":{\"home_tax\":true,\"eu_tax_registered\":true,\"eu_not_tax_registered\":true,\"rest_of_world_tax\":true,\"is_importer\":true}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact\": {\n \"name\": \"string\",\n \"contact_type_ids\": [\n \"string\"\n ],\n \"reference\": \"string\",\n \"default_sales_ledger_account_id\": \"string\",\n \"default_sales_tax_rate_id\": \"string\",\n \"default_purchase_ledger_account_id\": \"string\",\n \"tax_number\": \"string\",\n \"notes\": \"string\",\n \"locale\": \"string\",\n \"credit_limit\": 0.1,\n \"credit_days\": 365,\n \"credit_terms\": \"month_end_invoice\",\n \"credit_terms_and_conditions\": \"string\",\n \"product_sales_price_type_id\": \"string\",\n \"source_guid\": \"string\",\n \"currency_id\": \"string\",\n \"aux_reference\": \"string\",\n \"registered_number\": \"string\",\n \"tax_calculation\": \"string\",\n \"auxiliary_account\": \"string\",\n \"destination_vat_blocking\": true,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": true\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": true\n },\n \"main_contact_person\": {\n \"contact_person_type_ids\": [\n \"string\"\n ],\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": true,\n \"address_id\": \"string\",\n \"is_preferred_contact\": true\n },\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"tax_treatment\": {\n \"home_tax\": true,\n \"eu_tax_registered\": true,\n \"eu_not_tax_registered\": true,\n \"rest_of_world_tax\": true,\n \"is_importer\": true\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contacts/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact: {\n name: 'string',\n contact_type_ids: ['string'],\n reference: 'string',\n default_sales_ledger_account_id: 'string',\n default_sales_tax_rate_id: 'string',\n default_purchase_ledger_account_id: 'string',\n tax_number: 'string',\n notes: 'string',\n locale: 'string',\n credit_limit: 0.1,\n credit_days: 365,\n credit_terms: 'month_end_invoice',\n credit_terms_and_conditions: 'string',\n product_sales_price_type_id: 'string',\n source_guid: 'string',\n currency_id: 'string',\n aux_reference: 'string',\n registered_number: 'string',\n tax_calculation: 'string',\n auxiliary_account: 'string',\n destination_vat_blocking: true,\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n address_type_id: 'string',\n name: 'string',\n region: 'string',\n country_group_id: 'string',\n is_main_address: true\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n bank_account_id: 'string',\n contact_id: 'string',\n address_type_id: 'string',\n name: 'string',\n region: 'string',\n country_group_id: 'string',\n is_main_address: true\n },\n main_contact_person: {\n contact_person_type_ids: ['string'],\n name: 'string',\n job_title: 'string',\n telephone: 'string',\n mobile: 'string',\n email: 'string',\n fax: 'string',\n is_main_contact: true,\n address_id: 'string',\n is_preferred_contact: true\n },\n bank_account_details: {\n account_name: 'string',\n account_number: 'string',\n sort_code: 'string',\n bic: 'string',\n iban: 'string'\n },\n tax_treatment: {\n home_tax: true,\n eu_tax_registered: true,\n eu_not_tax_registered: true,\n rest_of_world_tax: true,\n is_importer: true\n }\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact\\\":{\\\"name\\\":\\\"string\\\",\\\"contact_type_ids\\\":[\\\"string\\\"],\\\"reference\\\":\\\"string\\\",\\\"default_sales_ledger_account_id\\\":\\\"string\\\",\\\"default_sales_tax_rate_id\\\":\\\"string\\\",\\\"default_purchase_ledger_account_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"credit_limit\\\":0.1,\\\"credit_days\\\":365,\\\"credit_terms\\\":\\\"month_end_invoice\\\",\\\"credit_terms_and_conditions\\\":\\\"string\\\",\\\"product_sales_price_type_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"currency_id\\\":\\\"string\\\",\\\"aux_reference\\\":\\\"string\\\",\\\"registered_number\\\":\\\"string\\\",\\\"tax_calculation\\\":\\\"string\\\",\\\"auxiliary_account\\\":\\\"string\\\",\\\"destination_vat_blocking\\\":true,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\",\\\"is_main_address\\\":true},\\\"main_contact_person\\\":{\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"address_id\\\":\\\"string\\\",\\\"is_preferred_contact\\\":true},\\\"bank_account_details\\\":{\\\"account_name\\\":\\\"string\\\",\\\"account_number\\\":\\\"string\\\",\\\"sort_code\\\":\\\"string\\\",\\\"bic\\\":\\\"string\\\",\\\"iban\\\":\\\"string\\\"},\\\"tax_treatment\\\":{\\\"home_tax\\\":true,\\\"eu_tax_registered\\\":true,\\\"eu_not_tax_registered\\\":true,\\\"rest_of_world_tax\\\":true,\\\"is_importer\\\":true}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/contacts/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\"\n\npayload = {\"contact\": {\n \"name\": \"string\",\n \"contact_type_ids\": [\"string\"],\n \"reference\": \"string\",\n \"default_sales_ledger_account_id\": \"string\",\n \"default_sales_tax_rate_id\": \"string\",\n \"default_purchase_ledger_account_id\": \"string\",\n \"tax_number\": \"string\",\n \"notes\": \"string\",\n \"locale\": \"string\",\n \"credit_limit\": 0.1,\n \"credit_days\": 365,\n \"credit_terms\": \"month_end_invoice\",\n \"credit_terms_and_conditions\": \"string\",\n \"product_sales_price_type_id\": \"string\",\n \"source_guid\": \"string\",\n \"currency_id\": \"string\",\n \"aux_reference\": \"string\",\n \"registered_number\": \"string\",\n \"tax_calculation\": \"string\",\n \"auxiliary_account\": \"string\",\n \"destination_vat_blocking\": True,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": True\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"contact_id\": \"string\",\n \"address_type_id\": \"string\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\",\n \"is_main_address\": True\n },\n \"main_contact_person\": {\n \"contact_person_type_ids\": [\"string\"],\n \"name\": \"string\",\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": True,\n \"address_id\": \"string\",\n \"is_preferred_contact\": True\n },\n \"bank_account_details\": {\n \"account_name\": \"string\",\n \"account_number\": \"string\",\n \"sort_code\": \"string\",\n \"bic\": \"string\",\n \"iban\": \"string\"\n },\n \"tax_treatment\": {\n \"home_tax\": True,\n \"eu_tax_registered\": True,\n \"eu_not_tax_registered\": True,\n \"rest_of_world_tax\": True,\n \"is_importer\": True\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Contact", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Contact" } }, "tags": [ "Contacts" ], "operationId": "deleteContactsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contacts/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/contacts/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contacts/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_types": { "get": { "summary": "Returns all Contact Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Contact Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Contact Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Contact Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contact Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 2, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "CUSTOMER", "displayed_as": "Customer", "$path": "/contact_types/CUSTOMER" }, { "id": "VENDOR", "displayed_as": "Supplier", "$path": "/contact_types/VENDOR" } ] } } } } } } }, "tags": [ "Contact Types" ], "operationId": "getContactTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_types/{key}": { "get": { "summary": "Returns a Contact Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Contact Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "VENDOR", "displayed_as": "Supplier", "$path": "/contact_types/VENDOR" } } } } } } }, "tags": [ "Contact Types" ], "operationId": "getContactTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_persons": { "get": { "summary": "Returns all Contact People", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "address_id", "description": "Use this to filter by address id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Address Contacts changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Address Contacts 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "email", "description": "Use this to filter by the contact person email address.", "required": false, "example": "2026-03-20T00:00:00Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Address Contacts per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Address Contacts", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Address Contacts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contact People", "content": { "application/json": { "examples": { "response": { "value": { "$total": 200, "$page": 1, "$next": "/contact_persons?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "bdee2bb9fbc44d0bb1fcf2b52a71d5ec", "displayed_as": "Main Contact", "$path": "/contact_persons/bdee2bb9fbc44d0bb1fcf2b52a71d5ec" }, { "id": "2d723f2b6d0c4d1ca8315096d8a30cab", "displayed_as": "Main Contact", "$path": "/contact_persons/2d723f2b6d0c4d1ca8315096d8a30cab" }, { "id": "39febacb4a7d469b9210362af6ebb0b3", "displayed_as": "Main Contact", "$path": "/contact_persons/39febacb4a7d469b9210362af6ebb0b3" }, { "id": "bc92c6d8c61b484aa7be92e857a74f3d", "displayed_as": "Main Contact", "$path": "/contact_persons/bc92c6d8c61b484aa7be92e857a74f3d" }, { "id": "5c70a4b3331148dfb4858726d4bc6b1b", "displayed_as": "Main Contact", "$path": "/contact_persons/5c70a4b3331148dfb4858726d4bc6b1b" }, { "id": "141d89e08f324277989443a6023bfdc3", "displayed_as": "Main Contact", "$path": "/contact_persons/141d89e08f324277989443a6023bfdc3" }, { "id": "625e487c409e413aa5b7b84a4d2bcc08", "displayed_as": "Main Contact", "$path": "/contact_persons/625e487c409e413aa5b7b84a4d2bcc08" }, { "id": "2aa7d3ef5fae4d2cb9e6cea23defb472", "displayed_as": "Main Contact", "$path": "/contact_persons/2aa7d3ef5fae4d2cb9e6cea23defb472" }, { "id": "bd6719bacb7e4d69a64f2b286ed02548", "displayed_as": "Main Contact", "$path": "/contact_persons/bd6719bacb7e4d69a64f2b286ed02548" }, { "id": "51f2260d22104365a93e404f4ccb4dba", "displayed_as": "Main Contact", "$path": "/contact_persons/51f2260d22104365a93e404f4ccb4dba" } ] } } } } } } }, "tags": [ "Contact People" ], "operationId": "getContactPersons", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_persons?address_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&email=2026-03-20T00%3A00%3A00Z&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_persons\"\n\nquerystring = {\"address_id\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"email\":\"2026-03-20T00:00:00Z\",\"contact_id\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Contact Person", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postContactPersons" }, "examples": { "Request example": { "value": { "contact_person": { "address_id": "string", "name": "string", "contact_person_type_ids": [ "string" ], "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "is_preferred_contact": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Contact Person", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPerson" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true } } } } } } }, "tags": [ "Contact People" ], "operationId": "postContactPersons", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/contact_persons \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_person\":{\"address_id\":\"string\",\"name\":\"string\",\"contact_person_type_ids\":[\"string\"],\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"is_preferred_contact\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_person\":{\"address_id\":\"string\",\"name\":\"string\",\"contact_person_type_ids\":[\"string\"],\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"is_preferred_contact\":true}}' | \\\n http POST https://api.accounting.sage.com/v3.1/contact_persons \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_person\":{\"address_id\":\"string\",\"name\":\"string\",\"contact_person_type_ids\":[\"string\"],\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"is_preferred_contact\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_persons", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_person\": {\n \"address_id\": \"string\",\n \"name\": \"string\",\n \"contact_person_type_ids\": [\n \"string\"\n ],\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": true,\n \"is_preferred_contact\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/contact_persons\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_persons\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_persons\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_person: {\n address_id: 'string',\n name: 'string',\n contact_person_type_ids: ['string'],\n job_title: 'string',\n telephone: 'string',\n mobile: 'string',\n email: 'string',\n fax: 'string',\n is_main_contact: true,\n is_preferred_contact: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_persons\"),\n Content = new StringContent(\"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_persons\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/contact_persons\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_persons\"\n\npayload = {\"contact_person\": {\n \"address_id\": \"string\",\n \"name\": \"string\",\n \"contact_person_type_ids\": [\"string\"],\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": True,\n \"is_preferred_contact\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/contact_persons/{key}": { "get": { "summary": "Returns a Contact Person", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access\n* Area: `Bank`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Person Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Address Contact (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Address Contact (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact Person", "content": { "application/json": { "examples": { "response": { "value": { "id": "5c70a4b3331148dfb4858726d4bc6b1b", "displayed_as": "Main Contact", "$path": "/contact_persons/5c70a4b3331148dfb4858726d4bc6b1b", "created_at": "2022-12-30T13:58:47Z", "updated_at": "2022-12-30T13:58:47Z", "contact_person_types": [ { "id": "ACCOUNTS", "displayed_as": "Accounts", "$path": "/contact_person_types/ACCOUNTS" } ], "name": "Main Contact", "job_title": null, "telephone": null, "mobile": null, "email": null, "fax": null, "is_main_contact": true, "address": { "id": "90234c75a8d54a91bc81320ee3ae5d0d", "displayed_as": "United Kingdom", "$path": "/addresses/90234c75a8d54a91bc81320ee3ae5d0d" } } } } } } } }, "tags": [ "Contact People" ], "operationId": "getContactPersonsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_persons/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Contact Person", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Person Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putContactPersons" }, "examples": { "Request example": { "value": { "contact_person": { "address_id": "string", "name": "string", "contact_person_type_ids": [ "string" ], "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "is_preferred_contact": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Contact Person", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPerson" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true } } } } } } }, "tags": [ "Contact People" ], "operationId": "putContactPersonsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_person\":{\"address_id\":\"string\",\"name\":\"string\",\"contact_person_type_ids\":[\"string\"],\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"is_preferred_contact\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_person\":{\"address_id\":\"string\",\"name\":\"string\",\"contact_person_type_ids\":[\"string\"],\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"is_preferred_contact\":true}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_person\":{\"address_id\":\"string\",\"name\":\"string\",\"contact_person_type_ids\":[\"string\"],\"job_title\":\"string\",\"telephone\":\"string\",\"mobile\":\"string\",\"email\":\"string\",\"fax\":\"string\",\"is_main_contact\":true,\"is_preferred_contact\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_person\": {\n \"address_id\": \"string\",\n \"name\": \"string\",\n \"contact_person_type_ids\": [\n \"string\"\n ],\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": true,\n \"is_preferred_contact\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_persons/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_person: {\n address_id: 'string',\n name: 'string',\n contact_person_type_ids: ['string'],\n job_title: 'string',\n telephone: 'string',\n mobile: 'string',\n email: 'string',\n fax: 'string',\n is_main_contact: true,\n is_preferred_contact: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_person\\\":{\\\"address_id\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"contact_person_type_ids\\\":[\\\"string\\\"],\\\"job_title\\\":\\\"string\\\",\\\"telephone\\\":\\\"string\\\",\\\"mobile\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"fax\\\":\\\"string\\\",\\\"is_main_contact\\\":true,\\\"is_preferred_contact\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/contact_persons/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\"\n\npayload = {\"contact_person\": {\n \"address_id\": \"string\",\n \"name\": \"string\",\n \"contact_person_type_ids\": [\"string\"],\n \"job_title\": \"string\",\n \"telephone\": \"string\",\n \"mobile\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"is_main_contact\": True,\n \"is_preferred_contact\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Contact Person", "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Person Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Contact Person" } }, "tags": [ "Contact People" ], "operationId": "deleteContactPersonsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_persons/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/contact_persons/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_persons/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_person_types": { "get": { "summary": "Returns all Contact Person Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Contact Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Contact Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Contact Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contact Person Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 3, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "ACCOUNTS", "displayed_as": "Accounts", "$path": "/contact_person_types/ACCOUNTS" }, { "id": "SALES", "displayed_as": "Sales", "$path": "/contact_person_types/SALES" }, { "id": "PURCHASING", "displayed_as": "Purchasing", "$path": "/contact_person_types/PURCHASING" } ] } } } } } } }, "tags": [ "Contact Person Types" ], "operationId": "getContactPersonTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_person_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_person_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_person_types/{key}": { "get": { "summary": "Returns a Contact Person Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Person Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Contact Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact Person Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "ACCOUNTS", "displayed_as": "Accounts", "$path": "/contact_person_types/ACCOUNTS" } } } } } } }, "tags": [ "Contact Person Types" ], "operationId": "getContactPersonTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_person_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_person_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/countries": { "get": { "summary": "Returns all Countries", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Countries per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Countries", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Countries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Countries", "content": { "application/json": { "examples": { "response": { "value": { "$total": 209, "$page": 1, "$next": "/countries?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "AF", "displayed_as": "Afghanistan (AF)", "$path": "/countries/AF" }, { "id": "AL", "displayed_as": "Albania (AL)", "$path": "/countries/AL" }, { "id": "DZ", "displayed_as": "Algeria (DZ)", "$path": "/countries/DZ" }, { "id": "AD", "displayed_as": "Andorra (AD)", "$path": "/countries/AD" }, { "id": "AO", "displayed_as": "Angola (AO)", "$path": "/countries/AO" }, { "id": "AR", "displayed_as": "Argentina (AR)", "$path": "/countries/AR" }, { "id": "AM", "displayed_as": "Armenia (AM)", "$path": "/countries/AM" }, { "id": "AW", "displayed_as": "Aruba (AW)", "$path": "/countries/AW" }, { "id": "AU", "displayed_as": "Australia (AU)", "$path": "/countries/AU" }, { "id": "AT", "displayed_as": "Austria (AT)", "$path": "/countries/AT" } ] } } } } } } }, "tags": [ "Countries" ], "operationId": "getCountries", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/countries?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/countries\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/countries/{key}": { "get": { "summary": "Returns a Country", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Country Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Country (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Country", "content": { "application/json": { "examples": { "response": { "value": { "id": "AU", "displayed_as": "Australia (AU)", "$path": "/countries/AU" } } } } } } }, "tags": [ "Countries" ], "operationId": "getCountriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/countries/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/countries/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/country_groups": { "get": { "summary": "Returns all Country Groups", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Country Groups per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Country Groups", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Country Groups (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Country Groups", "content": { "application/json": { "examples": { "response": { "value": { "$total": 5, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "ALL", "displayed_as": "Other", "$path": "/country_groups/ALL" }, { "id": "CA", "displayed_as": "Canada", "$path": "/country_groups/CA" }, { "id": "EU", "displayed_as": "Europe", "$path": "/country_groups/EU" }, { "id": "GBIE", "displayed_as": "UK & Ireland", "$path": "/country_groups/GBIE" }, { "id": "US", "displayed_as": "US", "$path": "/country_groups/US" } ] } } } } } } }, "tags": [ "Country Groups" ], "operationId": "getCountryGroups", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/country_groups?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/country_groups\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/country_groups/{key}": { "get": { "summary": "Returns a Country Group", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Country Group Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Country Group (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Country Group", "content": { "application/json": { "examples": { "response": { "value": { "id": "GBIE", "displayed_as": "UK & Ireland", "$path": "/country_groups/GBIE" } } } } } } }, "tags": [ "Country Groups" ], "operationId": "getCountryGroupsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/country_groups/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/country_groups/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/business_exchange_rates": { "get": { "summary": "Returns all Business Exchange Rates", "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 `Settings`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Business Exchange Rates per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Business Exchange Rates", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Business Exchange Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Business Exchange Rates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessExchangeRate" } }, "examples": { "200 response example": { "value": [ { "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate": 0.1, "inverse_rate": 0.1, "base_currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } } ] } } } } } }, "tags": [ "Business Exchange Rates" ], "operationId": "getBusinessExchangeRates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/business_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_exchange_rates\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Business Exchange Rate", "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 `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postBusinessExchangeRates" }, "examples": { "Request example": { "value": { "business_exchange_rate": { "currency_id": "string", "rate": 0.1, "inverse_rate": 0.1, "base_currency_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Business Exchange Rate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessExchangeRate" }, "examples": { "201 response example": { "value": { "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate": 0.1, "inverse_rate": 0.1, "base_currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Business Exchange Rates" ], "operationId": "postBusinessExchangeRates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/business_exchange_rates \\\n --header 'Content-Type: application/json' \\\n --data '{\"business_exchange_rate\":{\"currency_id\":\"string\",\"rate\":0.1,\"inverse_rate\":0.1,\"base_currency_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"business_exchange_rate\":{\"currency_id\":\"string\",\"rate\":0.1,\"inverse_rate\":0.1,\"base_currency_id\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/business_exchange_rates \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"business_exchange_rate\":{\"currency_id\":\"string\",\"rate\":0.1,\"inverse_rate\":0.1,\"base_currency_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/business_exchange_rates", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"business_exchange_rate\": {\n \"currency_id\": \"string\",\n \"rate\": 0.1,\n \"inverse_rate\": 0.1,\n \"base_currency_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/business_exchange_rates\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_exchange_rates\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_exchange_rates\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n business_exchange_rate: {\n currency_id: 'string',\n rate: 0.1,\n inverse_rate: 0.1,\n base_currency_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_exchange_rates\"),\n Content = new StringContent(\"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_exchange_rates\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/business_exchange_rates\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_exchange_rates\"\n\npayload = {\"business_exchange_rate\": {\n \"currency_id\": \"string\",\n \"rate\": 0.1,\n \"inverse_rate\": 0.1,\n \"base_currency_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/business_exchange_rates/{key}": { "get": { "summary": "Returns a Business Exchange Rate", "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 `Settings`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Business Exchange Rate Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Business Exchange Rate (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Business Exchange Rate", "content": { "application/json": { "examples": { "response": { "value": { "displayed_as": "GBP -> EUR", "$path": "/business_exchange_rates/EUR", "created_at": "2022-12-30T13:54:24Z", "updated_at": "2023-01-13T09:31:16Z", "rate": "1.127522832", "inverse_rate": "0.8869000003", "base_currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "currency": { "id": "EUR", "displayed_as": "Euro (EUR)", "$path": "/currencies/EUR" } } } } } } } }, "tags": [ "Business Exchange Rates" ], "operationId": "getBusinessExchangeRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/business_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Business Exchange Rate", "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 `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Business Exchange Rate Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putBusinessExchangeRates" }, "examples": { "Request example": { "value": { "business_exchange_rate": { "currency_id": "string", "rate": 0.1, "inverse_rate": 0.1, "base_currency_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Business Exchange Rate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessExchangeRate" }, "examples": { "200 response example": { "value": { "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate": 0.1, "inverse_rate": 0.1, "base_currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "currency": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Business Exchange Rates" ], "operationId": "putBusinessExchangeRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"business_exchange_rate\":{\"currency_id\":\"string\",\"rate\":0.1,\"inverse_rate\":0.1,\"base_currency_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"business_exchange_rate\":{\"currency_id\":\"string\",\"rate\":0.1,\"inverse_rate\":0.1,\"base_currency_id\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"business_exchange_rate\":{\"currency_id\":\"string\",\"rate\":0.1,\"inverse_rate\":0.1,\"base_currency_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"business_exchange_rate\": {\n \"currency_id\": \"string\",\n \"rate\": 0.1,\n \"inverse_rate\": 0.1,\n \"base_currency_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_exchange_rates/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n business_exchange_rate: {\n currency_id: 'string',\n rate: 0.1,\n inverse_rate: 0.1,\n base_currency_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"business_exchange_rate\\\":{\\\"currency_id\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"inverse_rate\\\":0.1,\\\"base_currency_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/business_exchange_rates/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\"\n\npayload = {\"business_exchange_rate\": {\n \"currency_id\": \"string\",\n \"rate\": 0.1,\n \"inverse_rate\": 0.1,\n \"base_currency_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Business Exchange Rate", "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 `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Business Exchange Rate Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Business Exchange Rate" } }, "tags": [ "Business Exchange Rates" ], "operationId": "deleteBusinessExchangeRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_exchange_rates/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/business_exchange_rates/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_exchange_rates/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/currencies": { "get": { "summary": "Returns all Currencies", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Currencies per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Currencies", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Currencies (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Currencies", "content": { "application/json": { "examples": { "response": { "value": { "$total": 34, "$page": 1, "$next": "/currencies?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "AUD", "displayed_as": "Australian Dollar (AUD)", "$path": "/currencies/AUD" }, { "id": "BGN", "displayed_as": "Bulgarian Lev (BGN)", "$path": "/currencies/BGN" }, { "id": "BRL", "displayed_as": "Brazilian Real (BRL)", "$path": "/currencies/BRL" }, { "id": "CAD", "displayed_as": "Canadian Dollar (CAD)", "$path": "/currencies/CAD" }, { "id": "CHF", "displayed_as": "Swiss Franc (CHF)", "$path": "/currencies/CHF" }, { "id": "CNY", "displayed_as": "Yuan Renminbi (CNY)", "$path": "/currencies/CNY" }, { "id": "CZK", "displayed_as": "Czech Koruna (CZK)", "$path": "/currencies/CZK" }, { "id": "DKK", "displayed_as": "Danish Krone (DKK)", "$path": "/currencies/DKK" }, { "id": "EUR", "displayed_as": "Euro (EUR)", "$path": "/currencies/EUR" }, { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" } ] } } } } } } }, "tags": [ "Currencies" ], "operationId": "getCurrencies", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/currencies?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/currencies\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/currencies/{key}": { "get": { "summary": "Returns a Currency", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Currency Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Currency (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Currency", "content": { "application/json": { "examples": { "response": { "value": { "id": "AUD", "displayed_as": "Australian Dollar (AUD)", "$path": "/currencies/AUD" } } } } } } }, "tags": [ "Currencies" ], "operationId": "getCurrenciesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/currencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/currencies/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/exchange_rates": { "get": { "summary": "Returns all Exchange Rates", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Currencies per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Currencies", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Currencies (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Exchange Rates", "content": { "application/json": { "examples": { "response": { "value": { "$total": 34, "$page": 1, "$next": "/exchange_rates?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "displayed_as": "GBP -> AUD", "$path": "/exchange_rates/AUD" }, { "displayed_as": "GBP -> BGN", "$path": "/exchange_rates/BGN" }, { "displayed_as": "GBP -> BRL", "$path": "/exchange_rates/BRL" }, { "displayed_as": "GBP -> CAD", "$path": "/exchange_rates/CAD" }, { "displayed_as": "GBP -> CHF", "$path": "/exchange_rates/CHF" }, { "displayed_as": "GBP -> CNY", "$path": "/exchange_rates/CNY" }, { "displayed_as": "GBP -> CZK", "$path": "/exchange_rates/CZK" }, { "displayed_as": "GBP -> DKK", "$path": "/exchange_rates/DKK" }, { "displayed_as": "GBP -> EUR", "$path": "/exchange_rates/EUR" }, { "displayed_as": "GBP -> GBP", "$path": "/exchange_rates/GBP" } ] } } } } } } }, "tags": [ "Exchange Rates" ], "operationId": "getExchangeRates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/exchange_rates\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/exchange_rates/{key}": { "get": { "summary": "Returns a Exchange Rate", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Exchange Rate Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Currency (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Exchange Rate", "content": { "application/json": { "examples": { "response": { "value": { "displayed_as": "GBP -> AUD", "$path": "/exchange_rates/AUD", "created_at": "2024-10-20T15:30:05Z", "updated_at": "2024-10-20T15:30:05Z", "rate": "1.9437263272", "inverse_rate": "0.5144757191", "base_currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "currency": { "id": "AUD", "displayed_as": "Australian Dollar (AUD)", "$path": "/currencies/AUD" } } } } } } } }, "tags": [ "Exchange Rates" ], "operationId": "getExchangeRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/exchange_rates/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/live_exchange_rates": { "get": { "summary": "Returns all Live Exchange Rates", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Currencies per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Currencies", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Currencies (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Live Exchange Rates", "content": { "application/json": { "examples": { "response": { "value": { "$total": 34, "$page": 1, "$next": "/live_exchange_rates?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "displayed_as": "GBP -> AUD", "$path": "/live_exchange_rates/AUD" }, { "displayed_as": "GBP -> BGN", "$path": "/live_exchange_rates/BGN" }, { "displayed_as": "GBP -> BRL", "$path": "/live_exchange_rates/BRL" }, { "displayed_as": "GBP -> CAD", "$path": "/live_exchange_rates/CAD" }, { "displayed_as": "GBP -> CHF", "$path": "/live_exchange_rates/CHF" }, { "displayed_as": "GBP -> CNY", "$path": "/live_exchange_rates/CNY" }, { "displayed_as": "GBP -> CZK", "$path": "/live_exchange_rates/CZK" }, { "displayed_as": "GBP -> DKK", "$path": "/live_exchange_rates/DKK" }, { "displayed_as": "GBP -> EUR", "$path": "/live_exchange_rates/EUR" }, { "displayed_as": "GBP -> GBP", "$path": "/live_exchange_rates/GBP" } ] } } } } } } }, "tags": [ "Live Exchange Rates" ], "operationId": "getLiveExchangeRates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/live_exchange_rates?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/live_exchange_rates\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/live_exchange_rates/{key}": { "get": { "summary": "Returns a Live Exchange Rate", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Live Exchange Rate Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Currency (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Live Exchange Rate", "content": { "application/json": { "examples": { "response": { "value": { "displayed_as": "GBP -> AUD", "$path": "/live_exchange_rates/AUD", "rate": "1.9437263272", "inverse_rate": "0.5144757191", "base_currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "currency": { "id": "AUD", "displayed_as": "Australian Dollar (AUD)", "$path": "/currencies/AUD" }, "retrieved_at": "2024-10-20T15:30:05Z", "updated_at": "2024-10-18T00:00:00Z" } } } } } } }, "tags": [ "Live Exchange Rates" ], "operationId": "getLiveExchangeRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/live_exchange_rates/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/live_exchange_rates/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/quick_entry_types": { "get": { "summary": "Returns all Quick Entry Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Batch Entry Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Batch Entry Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Batch Entry Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Quick Entry Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Quick Entry Types" ], "operationId": "getQuickEntryTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/quick_entry_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/quick_entry_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/quick_entry_types/{key}": { "get": { "summary": "Returns a Quick Entry Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Quick Entry Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Batch Entry Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Quick Entry Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Quick Entry Types" ], "operationId": "getQuickEntryTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/quick_entry_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/quick_entry_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/artefact_statuses": { "get": { "summary": "Returns all Artefact Statuses", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Artefact Statuses per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Artefact Statuses", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Artefact Statuses (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Artefact Statuses", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Artefact Statuses" ], "operationId": "getArtefactStatuses", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/artefact_statuses?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/artefact_statuses\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/artefact_statuses/{key}": { "get": { "summary": "Returns a Artefact Status", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Artefact Status Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Artefact Status (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Artefact Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Artefact Statuses" ], "operationId": "getArtefactStatusesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/artefact_statuses/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/artefact_statuses/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/eu_goods_services_types": { "get": { "summary": "Returns all EU Goods Services Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of EU Goods Services Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of EU Goods Services Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the EU Goods Services Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all EU Goods Services Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "EU Goods Services Types" ], "operationId": "getEuGoodsServicesTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/eu_goods_services_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/eu_goods_services_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/eu_goods_services_types/{key}": { "get": { "summary": "Returns a EU Goods Services Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The EU Goods Services Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the EU Goods Services Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a EU Goods Services Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "EU Goods Services Types" ], "operationId": "getEuGoodsServicesTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/eu_goods_services_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/eu_goods_services_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/purchase_credit_notes": { "get": { "summary": "Returns all Purchase Credit Notes", "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 `Purchases`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "search", "description": "Use this to filter by the credit note reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Purchase Credit Notes dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Purchase Credit Notes dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Purchase Credit Notes 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Purchase Credit Notes 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Purchase Credit Notes by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Purchase Credit Notes per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Purchase Credit Notes", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Purchase Credit Notes (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Purchase Credit Notes", "content": { "application/json": { "examples": { "response": { "value": { "$total": 13, "$page": 1, "$next": "/purchase_credit_notes?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "9bf8a7e219574e95a91b82c1071f66ab", "displayed_as": "20", "$path": "/purchase_credit_notes/9bf8a7e219574e95a91b82c1071f66ab" }, { "id": "29cfa26d42934357a7f6c9cacbdb13b9", "displayed_as": "323", "$path": "/purchase_credit_notes/29cfa26d42934357a7f6c9cacbdb13b9" }, { "id": "2db235abb90d47b7a1e7cbd86562dd8d", "displayed_as": "553", "$path": "/purchase_credit_notes/2db235abb90d47b7a1e7cbd86562dd8d" }, { "id": "09bc65a9f60a47a78b2e236e9f83ba46", "displayed_as": "557", "$path": "/purchase_credit_notes/09bc65a9f60a47a78b2e236e9f83ba46" }, { "id": "50739c2d34dc41b789ef47467d31cfaf", "displayed_as": "576", "$path": "/purchase_credit_notes/50739c2d34dc41b789ef47467d31cfaf" }, { "id": "98468577b35c45858259bd938e26ccb1", "displayed_as": "577", "$path": "/purchase_credit_notes/98468577b35c45858259bd938e26ccb1" }, { "id": "5dc76fbf906a4b29a66a58485a4247c5", "displayed_as": "593", "$path": "/purchase_credit_notes/5dc76fbf906a4b29a66a58485a4247c5" }, { "id": "1e969c56f027413e9a847ade46593c02", "displayed_as": "602", "$path": "/purchase_credit_notes/1e969c56f027413e9a847ade46593c02" }, { "id": "f369a061c8264817adbbe2b298ddffaf", "displayed_as": "611", "$path": "/purchase_credit_notes/f369a061c8264817adbbe2b298ddffaf" }, { "id": "a7fdb8f3bde947859a4b4a66b487317e", "displayed_as": "617", "$path": "/purchase_credit_notes/a7fdb8f3bde947859a4b4a66b487317e" } ] } } } } } } }, "tags": [ "Purchase Credit Notes" ], "operationId": "getPurchaseCreditNotes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/purchase_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_credit_notes\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"contact_id\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Purchase Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postPurchaseCreditNotes" }, "examples": { "Request example": { "value": { "purchase_credit_note": { "contact_id": "string", "date": "2019-08-24", "vat_reverse_charge": true, "postponed_accounting": true, "vat_exempt_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "original_invoice_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "credit_note_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "is_purchase_for_resale": true, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Purchase Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "postponed_accounting": true, "import": true, "vat_exempt_consignment": true, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "tax_calculation_method": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Purchase Credit Notes" ], "operationId": "postPurchaseCreditNotes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/purchase_credit_notes \\\n --header 'Content-Type: application/json' \\\n --data '{\"purchase_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":\"string\",\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"purchase_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":\"string\",\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/purchase_credit_notes \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"purchase_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":\"string\",\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_credit_notes", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"purchase_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"postponed_accounting\": true,\n \"vat_exempt_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": true,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": \"string\",\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": true,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/purchase_credit_notes\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_credit_notes\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_credit_notes\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n purchase_credit_note: {\n contact_id: 'string',\n date: '2019-08-24',\n vat_reverse_charge: true,\n postponed_accounting: true,\n vat_exempt_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n base_currency_total_itc_amount: 0.1,\n total_itc_amount: 0.1,\n base_currency_total_itr_amount: 0.1,\n total_itr_amount: 0.1,\n part_recoverable: true,\n contact_name: 'string',\n contact_reference: 'string',\n original_invoice_date: '2019-08-24',\n reference: 'string',\n vendor_reference: 'string',\n notes: 'string',\n total_quantity: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 'string',\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n credit_note_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n is_purchase_for_resale: true,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes\"),\n Content = new StringContent(\"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/purchase_credit_notes\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_credit_notes\"\n\npayload = {\"purchase_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"postponed_accounting\": True,\n \"vat_exempt_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": True,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": \"string\",\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": True,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/purchase_credit_notes/{key}": { "get": { "summary": "Returns a Purchase Credit Note", "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 `Purchases`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Credit Note Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Purchase Credit Note (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Purchase Credit Note (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Purchase Credit Note", "content": { "application/json": { "examples": { "response": { "value": { "id": "3bfcaf03913b421cbde8bb3c33b97881", "displayed_as": "24/02/2023 - 277.20", "$path": "/purchase_credit_notes/3bfcaf03913b421cbde8bb3c33b97881", "created_at": "2023-02-24T08:22:12Z", "updated_at": "2023-02-24T08:25:53Z", "links": [ { "href": "https://accounts-extra.sageone.com/invoicing/purchase_credit_notes/3bfcaf03913b421cbde8bb3c33b97881", "rel": "alternate", "type": "text/html" } ], "editable": true, "vat_reverse_charge": false, "transaction": { "id": "cc10fd875aa64816b9bbba2a0768bf3a", "displayed_as": "", "$path": "/transactions/cc10fd875aa64816b9bbba2a0768bf3a" }, "transaction_type": { "id": "PURCHASE_CREDIT_NOTE", "displayed_as": "Purchase Credit Note", "$path": "/transaction_types/PURCHASE_CREDIT_NOTE" }, "postponed_accounting": false, "import": false, "vat_exempt_consignment": false, "is_cis": false, "cis_applicable_amount": null, "base_currency_cis_applicable_amount": null, "total_after_cis_deduction": null, "base_currency_total_after_cis_deduction": null, "has_cis_labour": false, "has_cis_materials": false, "contact": { "id": "975c76ff2d3b4cd6b8d0faf37004ca73", "displayed_as": "McNally Computer Supplies (MCN001)", "$path": "/contacts/975c76ff2d3b4cd6b8d0faf37004ca73" }, "base_currency_total_itc_amount": null, "total_itc_amount": null, "base_currency_total_itr_amount": null, "total_itr_amount": null, "part_recoverable": null, "contact_name": "McNally Computer Supplies", "contact_reference": "MCN001", "date": "2023-02-24", "reference": "", "vendor_reference": "", "notes": "", "total_quantity": "1.0", "net_amount": "231.0", "tax_amount": "46.2", "total_amount": "277.2", "payments_allocations_total_amount": "10.0", "payments_allocations_total_discount": "0.0", "total_paid": "10.0", "outstanding_amount": "267.2", "currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "exchange_rate": "1.0", "inverse_exchange_rate": "1.0", "base_currency_net_amount": "231.0", "base_currency_tax_amount": "46.2", "base_currency_total_amount": "277.2", "base_currency_outstanding_amount": "267.2", "status": { "id": "PART_PAID", "displayed_as": "Part Paid", "$path": "/artefact_statuses/PART_PAID" }, "void_reason": null, "credit_note_lines": [ { "id": "168cd5fd435e4e2f8eec44603200ba83", "displayed_as": "trfuned items", "is_purchase_for_resale": false, "description": "trfuned items", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "231.0", "net_amount": "231.0", "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "tax_amount": "46.2", "tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "46.2" } ], "total_amount": "277.2", "base_currency_unit_price": "231.0", "unit_price_includes_tax": false, "base_currency_net_amount": "231.0", "base_currency_tax_amount": "46.2", "base_currency_tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "46.2" } ], "base_currency_total_amount": "277.2", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null } ], "tax_analysis": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "net_amount": "231.0", "tax_amount": "46.2", "total_amount": "277.2", "goods_amount": "0.0", "service_amount": "0.0" } ], "last_paid": "05/01/2022", "tax_address_region": null, "tax_reconciled": false, "migrated": false, "tax_calculation_method": null, "withholding_tax_rate": null, "withholding_tax_amount": null, "base_currency_withholding_tax_amount": null } } } } } } }, "tags": [ "Purchase Credit Notes" ], "operationId": "getPurchaseCreditNotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/purchase_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Purchase Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\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", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Credit Note Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putPurchaseCreditNotes" }, "examples": { "Request example": { "value": { "purchase_credit_note": { "contact_id": "string", "date": "2019-08-24", "vat_reverse_charge": true, "postponed_accounting": true, "vat_exempt_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "original_invoice_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "credit_note_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "is_purchase_for_resale": true, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Purchase Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "postponed_accounting": true, "import": true, "vat_exempt_consignment": true, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "tax_calculation_method": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Purchase Credit Notes" ], "operationId": "putPurchaseCreditNotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"purchase_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":\"string\",\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"purchase_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":\"string\",\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"purchase_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":\"string\",\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"purchase_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"postponed_accounting\": true,\n \"vat_exempt_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": true,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": \"string\",\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": true,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_credit_notes/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n purchase_credit_note: {\n contact_id: 'string',\n date: '2019-08-24',\n vat_reverse_charge: true,\n postponed_accounting: true,\n vat_exempt_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n base_currency_total_itc_amount: 0.1,\n total_itc_amount: 0.1,\n base_currency_total_itr_amount: 0.1,\n total_itr_amount: 0.1,\n part_recoverable: true,\n contact_name: 'string',\n contact_reference: 'string',\n original_invoice_date: '2019-08-24',\n reference: 'string',\n vendor_reference: 'string',\n notes: 'string',\n total_quantity: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 'string',\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n credit_note_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n is_purchase_for_resale: true,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"purchase_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":\\\"string\\\",\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/purchase_credit_notes/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\"\n\npayload = {\"purchase_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"postponed_accounting\": True,\n \"vat_exempt_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": True,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": \"string\",\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": True,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Purchase Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Purchases`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Credit Note Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Purchase Credit Note" } }, "tags": [ "Purchase Credit Notes" ], "operationId": "deletePurchaseCreditNotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_credit_notes/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/purchase_credit_notes/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/purchase_credit_notes/{key}/release": { "post": { "summary": "Releases a Purchase Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\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", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Credit Note Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Releases a Purchase Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "postponed_accounting": true, "import": true, "vat_exempt_consignment": true, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "tax_calculation_method": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Purchase Credit Notes" ], "operationId": "postPurchaseCreditNotesKeyRelease", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http POST https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release\",\n \"method\": \"POST\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_credit_notes/%7Bkey%7D/release\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release\");\nvar request = new RestRequest(Method.POST);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"POST\", \"/v3.1/purchase_credit_notes/%7Bkey%7D/release\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_credit_notes/%7Bkey%7D/release\"\n\nresponse = requests.request(\"POST\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/purchase_invoices": { "get": { "summary": "Returns all Purchase Invoices", "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 `Purchases`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "search", "description": "Use this to filter by the invoice reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Purchase Invoices dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Purchase Invoices dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Purchase Invoices changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Purchase Invoices 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Purchase Invoices by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "generate_filter_url", "description": "Use this to generate an api_filter_url to view a collection of filtered items in the application", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "copilot_vat_back_url", "description": "Return url to copilot vat page", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Purchase Invoices per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Purchase Invoices", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Purchase Invoices (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date, due_date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Purchase Invoices", "content": { "application/json": { "examples": { "response": { "value": { "$total": 109, "$page": 1, "$next": "/purchase_invoices?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "8a27388ef8534a8bacdc21e781ea13bd", "displayed_as": "86", "$path": "/purchase_invoices/8a27388ef8534a8bacdc21e781ea13bd" }, { "id": "2dec01ec765d4734b5924e00d02dfbb3", "displayed_as": "87", "$path": "/purchase_invoices/2dec01ec765d4734b5924e00d02dfbb3" }, { "id": "7ec4b16bbc4a4270a28a83da852ee6fe", "displayed_as": "92", "$path": "/purchase_invoices/7ec4b16bbc4a4270a28a83da852ee6fe" }, { "id": "ccd248455327499d8b1d3cf940f45eb7", "displayed_as": "11", "$path": "/purchase_invoices/ccd248455327499d8b1d3cf940f45eb7" }, { "id": "d2bb2ecf3a944cf39a25e38dac6919aa", "displayed_as": "12", "$path": "/purchase_invoices/d2bb2ecf3a944cf39a25e38dac6919aa" }, { "id": "11925c87e06f40658022e03bd05beb5a", "displayed_as": "13", "$path": "/purchase_invoices/11925c87e06f40658022e03bd05beb5a" }, { "id": "7a5d94330874465a89ccac8e56b3e8e9", "displayed_as": "14", "$path": "/purchase_invoices/7a5d94330874465a89ccac8e56b3e8e9" }, { "id": "dc48ac275c034c668f0643bd31fb250b", "displayed_as": "15", "$path": "/purchase_invoices/dc48ac275c034c668f0643bd31fb250b" }, { "id": "114561ffd768491fa7f714c05863f51f", "displayed_as": "16", "$path": "/purchase_invoices/114561ffd768491fa7f714c05863f51f" }, { "id": "4df1412545164c25a787c7cd5cad17e0", "displayed_as": "17", "$path": "/purchase_invoices/4df1412545164c25a787c7cd5cad17e0" } ] } } } } } } }, "tags": [ "Purchase Invoices" ], "operationId": "getPurchaseInvoices", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/purchase_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_invoices\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"contact_id\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"generate_filter_url\":\"SOME_BOOLEAN_VALUE\",\"copilot_vat_back_url\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Purchase Invoice", "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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postPurchaseInvoices" }, "examples": { "Request example": { "value": { "purchase_invoice": { "contact_id": "string", "date": "2019-08-24", "due_date": "2019-08-24", "vat_reverse_charge": true, "postponed_accounting": true, "vat_exempt_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "invoice_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "is_purchase_for_resale": true, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Purchase Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "postponed_accounting": true, "import": true, "vat_exempt_consignment": true, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "tax_reconciled": true, "import": true } ], "tax_reconciled": true, "migrated": true, "tax_calculation_method": "string" } } } } } } }, "tags": [ "Purchase Invoices" ], "operationId": "postPurchaseInvoices", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/purchase_invoices \\\n --header 'Content-Type: application/json' \\\n --data '{\"purchase_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"due_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"purchase_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"due_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/purchase_invoices \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"purchase_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"due_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_invoices", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"purchase_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"due_date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"postponed_accounting\": true,\n \"vat_exempt_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": true,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": true,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/purchase_invoices\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_invoices\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_invoices\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n purchase_invoice: {\n contact_id: 'string',\n date: '2019-08-24',\n due_date: '2019-08-24',\n vat_reverse_charge: true,\n postponed_accounting: true,\n vat_exempt_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n base_currency_total_itc_amount: 0.1,\n total_itc_amount: 0.1,\n base_currency_total_itr_amount: 0.1,\n total_itr_amount: 0.1,\n part_recoverable: true,\n contact_name: 'string',\n contact_reference: 'string',\n reference: 'string',\n vendor_reference: 'string',\n notes: 'string',\n total_quantity: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n invoice_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n is_purchase_for_resale: true,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_invoices\"),\n Content = new StringContent(\"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_invoices\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/purchase_invoices\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_invoices\"\n\npayload = {\"purchase_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"due_date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"postponed_accounting\": True,\n \"vat_exempt_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": True,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": True,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/purchase_invoices/{key}": { "get": { "summary": "Returns a Purchase Invoice", "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 `Purchases`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Invoice Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "show_corrections", "description": "Use this to show the artefact's associated corrections", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Purchase Invoice (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Purchase Invoice (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Purchase Invoice", "content": { "application/json": { "examples": { "response": { "value": { "id": "aefba8481956416a84a094d6c41c97df", "displayed_as": "RB12972968870", "$path": "/purchase_invoices/aefba8481956416a84a094d6c41c97df", "created_at": "2024-05-15T08:43:53Z", "updated_at": "2024-07-26T07:57:49Z", "links": [ { "href": "https://accounts-extra.sageone.com/invoicing/purchase_invoices/aefba8481956416a84a094d6c41c97df", "rel": "alternate", "type": "text/html" } ], "editable": true, "vat_reverse_charge": false, "transaction": { "id": "5876e869ca544e0eb93ad43e3975dfde", "displayed_as": "RB12972968870", "$path": "/transactions/5876e869ca544e0eb93ad43e3975dfde" }, "transaction_type": { "id": "PURCHASE_INVOICE", "displayed_as": "Purchase Invoice", "$path": "/transaction_types/PURCHASE_INVOICE" }, "postponed_accounting": false, "import": false, "vat_exempt_consignment": false, "is_cis": false, "cis_applicable_amount": null, "base_currency_cis_applicable_amount": null, "total_after_cis_deduction": null, "base_currency_total_after_cis_deduction": null, "has_cis_labour": false, "has_cis_materials": false, "contact": { "id": "5ad3e87117f54189ba0255a12a2c3034", "displayed_as": "Thompsons Electricals (THO001)", "$path": "/contacts/5ad3e87117f54189ba0255a12a2c3034" }, "base_currency_total_itc_amount": null, "total_itc_amount": null, "base_currency_total_itr_amount": null, "total_itr_amount": null, "part_recoverable": null, "contact_name": "Thompsons Electricals", "contact_reference": "THO001", "date": "2024-05-15", "due_date": "2024-06-14", "reference": "RB12972968870", "vendor_reference": "", "notes": "", "total_quantity": "24.0", "net_amount": "1572.87", "tax_amount": "26.24", "total_amount": "1599.11", "payments_allocations_total_amount": "0.0", "payments_allocations_total_discount": "0.0", "total_paid": "0.0", "outstanding_amount": "1599.11", "currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "exchange_rate": "1.0", "inverse_exchange_rate": "1.0", "base_currency_net_amount": "1572.87", "base_currency_tax_amount": "26.24", "base_currency_total_amount": "1599.11", "base_currency_outstanding_amount": "1599.11", "status": { "id": "UNPAID", "displayed_as": "Unpaid", "$path": "/artefact_statuses/UNPAID" }, "void_reason": null, "invoice_lines": [ { "id": "97b26ddfbb92487aa8bf059d222cbd7b", "displayed_as": "16mb PCI Video Card", "is_purchase_for_resale": false, "description": "16mb PCI Video Card", "product": { "id": "a3c4f6f1642a45b4b0c238824837fb29", "displayed_as": "16mb PCI Video Card", "$path": "/products/a3c4f6f1642a45b4b0c238824837fb29" }, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "34.0", "net_amount": "34.0", "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "tax_amount": "6.8", "tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "6.8" } ], "total_amount": "40.8", "base_currency_unit_price": "34.0", "unit_price_includes_tax": false, "base_currency_net_amount": "34.0", "base_currency_tax_amount": "6.8", "base_currency_tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "6.8" } ], "base_currency_total_amount": "40.8", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "b0dd1868eadc466599de0d846a327cdd", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "43.15", "net_amount": "43.15", "tax_rate": { "id": "GB_NO_TAX", "displayed_as": "No VAT", "$path": "/tax_rates/GB_NO_TAX" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "43.15", "base_currency_unit_price": "43.15", "unit_price_includes_tax": false, "base_currency_net_amount": "43.15", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "43.15", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "d08c97ee0abe4dfd972466ac426d5903", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "39.6", "net_amount": "39.6", "tax_rate": { "id": "GB_NO_TAX", "displayed_as": "No VAT", "$path": "/tax_rates/GB_NO_TAX" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "39.6", "base_currency_unit_price": "39.6", "unit_price_includes_tax": false, "base_currency_net_amount": "39.6", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "39.6", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "a43a77e283a246938be39383c62cce16", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "8.0", "net_amount": "8.0", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "8.0", "base_currency_unit_price": "8.0", "unit_price_includes_tax": false, "base_currency_net_amount": "8.0", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "8.0", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "936457dc17064b67a11dc9747ba76a46", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "31.4", "net_amount": "31.4", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "31.4", "base_currency_unit_price": "31.4", "unit_price_includes_tax": false, "base_currency_net_amount": "31.4", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "31.4", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "5c5dddd8bc2c4f54be51ba7630f3e43e", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "30.1", "net_amount": "30.1", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "30.1", "base_currency_unit_price": "30.1", "unit_price_includes_tax": false, "base_currency_net_amount": "30.1", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "30.1", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "4afbf0988a024980a7163f1131c3dcf9", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "22.1", "net_amount": "22.1", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "22.1", "base_currency_unit_price": "22.1", "unit_price_includes_tax": false, "base_currency_net_amount": "22.1", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "22.1", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "20aba902625d4940989bfaa237b5184f", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "8.0", "net_amount": "8.0", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "8.0", "base_currency_unit_price": "8.0", "unit_price_includes_tax": false, "base_currency_net_amount": "8.0", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "8.0", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "564cc1733c9e4727b7dabcf2215b26d1", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "40.0", "net_amount": "40.0", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "40.0", "base_currency_unit_price": "40.0", "unit_price_includes_tax": false, "base_currency_net_amount": "40.0", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "40.0", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "2349eea8bb674322a784c3d8a98d3c00", "displayed_as": "Dinner with Bijal - Mars", "is_purchase_for_resale": false, "description": "Dinner with Bijal - Mars", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "408.38", "net_amount": "408.38", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "408.38", "base_currency_unit_price": "408.38", "unit_price_includes_tax": false, "base_currency_net_amount": "408.38", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "408.38", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "8bf6631d46084aafb880a74e4353507a", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "31.4", "net_amount": "31.4", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "31.4", "base_currency_unit_price": "31.4", "unit_price_includes_tax": false, "base_currency_net_amount": "31.4", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "31.4", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "bb1c9fc63e0448f58cfa8c2955ecf0e9", "displayed_as": "Training ", "is_purchase_for_resale": false, "description": "Training ", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "312.55", "net_amount": "312.55", "tax_rate": { "id": "GB_NO_TAX", "displayed_as": "No VAT", "$path": "/tax_rates/GB_NO_TAX" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "312.55", "base_currency_unit_price": "312.55", "unit_price_includes_tax": false, "base_currency_net_amount": "312.55", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "312.55", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "a2b4c2114a714da2a1a600aa59f17f2d", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "168.75", "net_amount": "168.75", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "168.75", "base_currency_unit_price": "168.75", "unit_price_includes_tax": false, "base_currency_net_amount": "168.75", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "168.75", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "a722c1e23f484fbcb1adf1dbff507226", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "26.4", "net_amount": "26.4", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "26.4", "base_currency_unit_price": "26.4", "unit_price_includes_tax": false, "base_currency_net_amount": "26.4", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "26.4", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "66c3dc61dd3f49af998e52e63d9aa13a", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "33.4", "net_amount": "33.4", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "33.4", "base_currency_unit_price": "33.4", "unit_price_includes_tax": false, "base_currency_net_amount": "33.4", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "33.4", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "6b98c7c76ecc465a843f995d2d374e79", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "36.4", "net_amount": "36.4", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "36.4", "base_currency_unit_price": "36.4", "unit_price_includes_tax": false, "base_currency_net_amount": "36.4", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "36.4", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "2e40691816fa43358117f4f63d60e685", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "100.9", "net_amount": "100.9", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "100.9", "base_currency_unit_price": "100.9", "unit_price_includes_tax": false, "base_currency_net_amount": "100.9", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "100.9", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "629a339653484122b4594e33ffa3cf08", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "79.95", "net_amount": "79.95", "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "tax_amount": "15.99", "tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "15.99" } ], "total_amount": "95.94", "base_currency_unit_price": "79.95", "unit_price_includes_tax": false, "base_currency_net_amount": "79.95", "base_currency_tax_amount": "15.99", "base_currency_tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "15.99" } ], "base_currency_total_amount": "95.94", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "7fe7138aec76483ab5e7dfbada784a10", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "14.14", "net_amount": "14.14", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "14.14", "base_currency_unit_price": "14.14", "unit_price_includes_tax": false, "base_currency_net_amount": "14.14", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "14.14", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "859f69f0d6874d768e35918ffc1bff8d", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "13.6", "net_amount": "13.6", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "13.6", "base_currency_unit_price": "13.6", "unit_price_includes_tax": false, "base_currency_net_amount": "13.6", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "13.6", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "1c8e43dd90224586995864cef8af2bc9", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "18.9", "net_amount": "18.9", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "18.9", "base_currency_unit_price": "18.9", "unit_price_includes_tax": false, "base_currency_net_amount": "18.9", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "18.9", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "b0022d9f7a6746a1bb44ee08b065df81", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "17.25", "net_amount": "17.25", "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "tax_amount": "3.45", "tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "3.45" } ], "total_amount": "20.7", "base_currency_unit_price": "17.25", "unit_price_includes_tax": false, "base_currency_net_amount": "17.25", "base_currency_tax_amount": "3.45", "base_currency_tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "3.45" } ], "base_currency_total_amount": "20.7", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "dcb9272bac024cefb841679aa174d1f2", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "45.5", "net_amount": "45.5", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "45.5", "base_currency_unit_price": "45.5", "unit_price_includes_tax": false, "base_currency_net_amount": "45.5", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "45.5", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null }, { "id": "7b377469823d485c82c54655d711da87", "displayed_as": ".", "is_purchase_for_resale": false, "description": ".", "product": null, "service": null, "ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "trade_of_asset": false, "quantity": "1.0", "unit_price": "9.0", "net_amount": "9.0", "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "9.0", "base_currency_unit_price": "9.0", "unit_price_includes_tax": false, "base_currency_net_amount": "9.0", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "9.0", "eu_goods_services_type": null, "gst_amount": null, "pst_amount": null, "tax_recoverable": null } ], "tax_analysis": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "net_amount": "131.2", "tax_amount": "26.24", "total_amount": "157.44", "goods_amount": "34.0", "service_amount": "0.0" }, { "tax_rate": { "id": "GB_ZERO", "displayed_as": "Zero Rated 0.00%", "$path": "/tax_rates/GB_ZERO" }, "net_amount": "1046.37", "tax_amount": "0.0", "total_amount": "1046.37", "goods_amount": "0.0", "service_amount": "0.0" }, { "tax_rate": { "id": "GB_NO_TAX", "displayed_as": "No VAT", "$path": "/tax_rates/GB_NO_TAX" }, "net_amount": "395.3", "tax_amount": "0.0", "total_amount": "395.3", "goods_amount": "0.0", "service_amount": "0.0" } ], "last_paid": "", "tax_address_region": null, "withholding_tax_rate": null, "withholding_tax_amount": null, "base_currency_withholding_tax_amount": null, "tax_reconciled": false, "migrated": false, "tax_calculation_method": null } } } } } } }, "tags": [ "Purchase Invoices" ], "operationId": "getPurchaseInvoicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/purchase_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"show_corrections\":\"SOME_BOOLEAN_VALUE\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Purchase Invoice", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Invoice Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putPurchaseInvoices" }, "examples": { "Request example": { "value": { "purchase_invoice": { "contact_id": "string", "date": "2019-08-24", "due_date": "2019-08-24", "vat_reverse_charge": true, "postponed_accounting": true, "vat_exempt_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "invoice_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "is_purchase_for_resale": true, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Purchase Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "postponed_accounting": true, "import": true, "vat_exempt_consignment": true, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "tax_reconciled": true, "import": true } ], "tax_reconciled": true, "migrated": true, "tax_calculation_method": "string" } } } } } } }, "tags": [ "Purchase Invoices" ], "operationId": "putPurchaseInvoicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"purchase_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"due_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"purchase_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"due_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"purchase_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"due_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"postponed_accounting\":true,\"vat_exempt_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"vendor_reference\":\"string\",\"notes\":\"string\",\"total_quantity\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"is_purchase_for_resale\":true,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"purchase_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"due_date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"postponed_accounting\": true,\n \"vat_exempt_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": true,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": true,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_invoices/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n purchase_invoice: {\n contact_id: 'string',\n date: '2019-08-24',\n due_date: '2019-08-24',\n vat_reverse_charge: true,\n postponed_accounting: true,\n vat_exempt_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n base_currency_total_itc_amount: 0.1,\n total_itc_amount: 0.1,\n base_currency_total_itr_amount: 0.1,\n total_itr_amount: 0.1,\n part_recoverable: true,\n contact_name: 'string',\n contact_reference: 'string',\n reference: 'string',\n vendor_reference: 'string',\n notes: 'string',\n total_quantity: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n invoice_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n is_purchase_for_resale: true,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"purchase_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"postponed_accounting\\\":true,\\\"vat_exempt_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"vendor_reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"total_quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/purchase_invoices/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\"\n\npayload = {\"purchase_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"due_date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"postponed_accounting\": True,\n \"vat_exempt_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": True,\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"vendor_reference\": \"string\",\n \"notes\": \"string\",\n \"total_quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"is_purchase_for_resale\": True,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Purchase Invoice", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Invoice Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Purchase Invoice" } }, "tags": [ "Purchase Invoices" ], "operationId": "deletePurchaseInvoicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_invoices/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/purchase_invoices/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/purchase_invoices/{key}/release": { "post": { "summary": "Releases a Purchase Invoice", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Invoice Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Releases a Purchase Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "postponed_accounting": true, "import": true, "vat_exempt_consignment": true, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "vendor_reference": "string", "notes": "string", "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": "string", "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "is_purchase_for_resale": true, "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "tax_reconciled": true, "import": true } ], "tax_reconciled": true, "migrated": true, "tax_calculation_method": "string" } } } } } } }, "tags": [ "Purchase Invoices" ], "operationId": "postPurchaseInvoicesKeyRelease", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http POST https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release\",\n \"method\": \"POST\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_invoices/%7Bkey%7D/release\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release\");\nvar request = new RestRequest(Method.POST);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"POST\", \"/v3.1/purchase_invoices/%7Bkey%7D/release\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_invoices/%7Bkey%7D/release\"\n\nresponse = requests.request(\"POST\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/purchase_quick_entries": { "get": { "summary": "Returns all Purchase Quick Entries", "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 `Purchases`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "search", "description": "Use this to filter by the quick entry reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Purchase Batch Entries dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Purchase Batch Entries dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Purchase Batch Entries by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Purchase Batch Entries per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Purchase Batch Entries", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "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)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Purchase Quick Entries", "content": { "application/json": { "examples": { "response": { "value": { "$total": 18, "$page": 1, "$next": "/purchase_quick_entries?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "d2b7ed37544e444887e49f3f74482474", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/d2b7ed37544e444887e49f3f74482474" }, { "id": "5ed6ca8f15dc4556a3d09a8687e4bb24", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/5ed6ca8f15dc4556a3d09a8687e4bb24" }, { "id": "6442c8cd4f6041b0ba0be74a58e55032", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/6442c8cd4f6041b0ba0be74a58e55032" }, { "id": "bd5cddbe044a48e5828e0a97409ee006", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/bd5cddbe044a48e5828e0a97409ee006" }, { "id": "46edee13628b4215ab120478154b9673", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/46edee13628b4215ab120478154b9673" }, { "id": "e846488332684285bb1cbb43d47c1f73", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/e846488332684285bb1cbb43d47c1f73" }, { "id": "ce1bed1009df47d2a1f6f5d7741efcb6", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/ce1bed1009df47d2a1f6f5d7741efcb6" }, { "id": "fdcf1052687d4334b71ac61ddd3edaa6", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/fdcf1052687d4334b71ac61ddd3edaa6" }, { "id": "3351928d486641a0bacab1b578bbfc55", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/3351928d486641a0bacab1b578bbfc55" }, { "id": "9bbbd82f785b4b1aa4bb64823b3c0787", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/9bbbd82f785b4b1aa4bb64823b3c0787" } ] } } } } } } }, "tags": [ "Purchase Quick Entries" ], "operationId": "getPurchaseQuickEntries", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/purchase_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_quick_entries\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Purchase Quick Entry", "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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postPurchaseQuickEntries" }, "examples": { "Request example": { "value": { "purchase_quick_entry": { "quick_entry_type_id": "string", "date": "2019-08-24", "contact_id": "string", "reference": "string", "ledger_account_id": "string", "contact_name": "string", "contact_reference": "string", "details": "string", "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true, "analysis_type_categories": [ { "analysis_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Purchase Quick Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseQuickEntry" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "quick_entry_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "migrated": true, "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } } } } } } }, "tags": [ "Purchase Quick Entries" ], "operationId": "postPurchaseQuickEntries", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/purchase_quick_entries \\\n --header 'Content-Type: application/json' \\\n --data '{\"purchase_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"purchase_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/purchase_quick_entries \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"purchase_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_quick_entries", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"purchase_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": true,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true,\n \"analysis_type_categories\": [\n {\n \"analysis_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/purchase_quick_entries\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_quick_entries\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_quick_entries\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n purchase_quick_entry: {\n quick_entry_type_id: 'string',\n date: '2019-08-24',\n contact_id: 'string',\n reference: 'string',\n ledger_account_id: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n details: 'string',\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n trade_of_asset: true,\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true,\n analysis_type_categories: [{analysis_type_id: 'string'}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries\"),\n Content = new StringContent(\"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/purchase_quick_entries\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_quick_entries\"\n\npayload = {\"purchase_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": True,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True,\n \"analysis_type_categories\": [{\"analysis_type_id\": \"string\"}]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/purchase_quick_entries/{key}": { "get": { "summary": "Returns a Purchase Quick Entry", "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 `Purchases`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Quick Entry Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Purchase Batch Entry (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Purchase Batch Entry (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Purchase Quick Entry", "content": { "application/json": { "examples": { "response": { "value": { "id": "1cb11d7cba5f4a6f819a067bb06a8355", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/1cb11d7cba5f4a6f819a067bb06a8355", "created_at": "2022-12-30T14:02:19Z", "updated_at": "2022-12-30T14:02:19Z", "transaction": { "id": "af777984d4b3488dbec3c0fc2492716e", "displayed_as": "O/BAL", "$path": "/transactions/af777984d4b3488dbec3c0fc2492716e" }, "transaction_type": { "id": "VENDOR_OPENING_BALANCE_INVOICE", "displayed_as": "Supplier OB Invoice", "$path": "/transaction_types/VENDOR_OPENING_BALANCE_INVOICE" }, "quick_entry_type": { "id": "INVOICE", "displayed_as": "Invoice", "$path": "/quick_entry_types/INVOICE" }, "contact_name": "Thompsons Electricals", "contact_reference": "THO001", "contact": { "id": "5ad3e87117f54189ba0255a12a2c3034", "displayed_as": "Thompsons Electricals (THO001)", "$path": "/contacts/5ad3e87117f54189ba0255a12a2c3034" }, "date": "2021-12-31", "due_date": "2022-01-30", "reference": "O/BAL", "ledger_account": { "id": "7a632154884911ed84fa0252b90cda0d", "displayed_as": "Opening Balances (9998)", "$path": "/ledger_accounts/7a632154884911ed84fa0252b90cda0d" }, "details": null, "net_amount": "36.98", "tax_rate": { "id": "GB_NO_TAX", "displayed_as": "No VAT", "$path": "/tax_rates/GB_NO_TAX" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "36.98", "outstanding_amount": "36.98", "currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "exchange_rate": "1.0", "inverse_exchange_rate": "1.0", "base_currency_net_amount": "36.98", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "36.98", "base_currency_outstanding_amount": "36.98", "status": { "id": "UNPAID", "displayed_as": "Unpaid", "$path": "/artefact_statuses/UNPAID" }, "tax_address_region": null, "migrated": false, "trade_of_asset": false, "gst_amount": null, "pst_amount": null, "tax_recoverable": null } } } } } } }, "tags": [ "Purchase Quick Entries" ], "operationId": "getPurchaseQuickEntriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/purchase_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Purchase Quick Entry", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Quick Entry Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putPurchaseQuickEntries" }, "examples": { "Request example": { "value": { "purchase_quick_entry": { "quick_entry_type_id": "string", "date": "2019-08-24", "contact_id": "string", "reference": "string", "ledger_account_id": "string", "contact_name": "string", "contact_reference": "string", "details": "string", "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true, "analysis_type_categories": [ { "analysis_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Purchase Quick Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseQuickEntry" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "quick_entry_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "migrated": true, "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } } } } } } }, "tags": [ "Purchase Quick Entries" ], "operationId": "putPurchaseQuickEntriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"purchase_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"purchase_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"purchase_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"purchase_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": true,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true,\n \"analysis_type_categories\": [\n {\n \"analysis_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_quick_entries/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n purchase_quick_entry: {\n quick_entry_type_id: 'string',\n date: '2019-08-24',\n contact_id: 'string',\n reference: 'string',\n ledger_account_id: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n details: 'string',\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n trade_of_asset: true,\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true,\n analysis_type_categories: [{analysis_type_id: 'string'}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"purchase_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/purchase_quick_entries/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\"\n\npayload = {\"purchase_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": True,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True,\n \"analysis_type_categories\": [{\"analysis_type_id\": \"string\"}]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Purchase Quick Entry", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Purchase Quick Entry Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Purchase Quick Entry" } }, "tags": [ "Purchase Quick Entries" ], "operationId": "deletePurchaseQuickEntriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/purchase_quick_entries/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/purchase_quick_entries/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/purchase_quick_entries/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/eu_sales_descriptions": { "get": { "summary": "Returns all EU Sales Descriptions", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Ec Sales Descriptions per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Ec Sales Descriptions", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ec Sales Descriptions (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all EU Sales Descriptions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EuSalesDescription" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "EU Sales Descriptions" ], "operationId": "getEuSalesDescriptions", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/eu_sales_descriptions?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/eu_sales_descriptions\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/eu_sales_descriptions/{key}": { "get": { "summary": "Returns a EU Sales Description", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The EU Sales Description Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Ec Sales Description (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a EU Sales Description", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EuSalesDescription" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "EU Sales Descriptions" ], "operationId": "getEuSalesDescriptionsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/eu_sales_descriptions/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/eu_sales_descriptions/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/sales_credit_notes": { "get": { "summary": "Returns all Sales Credit Notes", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "search", "description": "Use this to filter by the credit note reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Sales Credit Notes dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Sales Credit Notes dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Sales Credit Notes 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Sales Credit Notes 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Sales Credit Notes by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Sales Credit Notes per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Sales Credit Notes", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Credit Notes (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Sales Credit Notes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCreditNote" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } ] } } } } } }, "tags": [ "Sales Credit Notes" ], "operationId": "getSalesCreditNotes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_credit_notes?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_credit_notes\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"contact_id\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Sales Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSalesCreditNotes" }, "examples": { "Request example": { "value": { "sales_credit_note": { "contact_id": "string", "date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "original_invoice_date": "2019-08-24", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "credit_note_lines": [ { "description": "string", "ledger_account_id": "string", "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "quantity": 0.1, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Sales Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNote" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Sales Credit Notes" ], "operationId": "postSalesCreditNotes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/sales_credit_notes \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"credit_note_number_prefix\":\"string\",\"credit_note_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"total_quantity\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"credit_note_number_prefix\":\"string\",\"credit_note_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"total_quantity\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/sales_credit_notes \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"credit_note_number_prefix\":\"string\",\"credit_note_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"total_quantity\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_credit_notes", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"credit_note_number_prefix\": \"string\",\n \"credit_note_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/sales_credit_notes\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_credit_notes\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_credit_notes\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_credit_note: {\n contact_id: 'string',\n date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n credit_note_number_prefix: 'string',\n credit_note_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n original_invoice_date: '2019-08-24',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n total_quantity: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n credit_note_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n quantity: 0.1,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_credit_notes\"),\n Content = new StringContent(\"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_credit_notes\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/sales_credit_notes\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_credit_notes\"\n\npayload = {\"sales_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"credit_note_number_prefix\": \"string\",\n \"credit_note_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/sales_credit_notes/{key}": { "get": { "summary": "Returns a Sales Credit Note", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Credit Note Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Sales Credit Note (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "mark_as_sent", "description": "Use this to mark/not mark the artefact as sent. Defaulted to 'true'.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Credit Note (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Sales Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNote" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Sales Credit Notes" ], "operationId": "getSalesCreditNotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_credit_notes/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"mark_as_sent\":\"SOME_BOOLEAN_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Sales Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Credit Note Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putSalesCreditNotes" }, "examples": { "Request example": { "value": { "sales_credit_note": { "contact_id": "string", "date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "original_invoice_date": "2019-08-24", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "credit_note_lines": [ { "description": "string", "ledger_account_id": "string", "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "quantity": 0.1, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Sales Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNote" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Sales Credit Notes" ], "operationId": "putSalesCreditNotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"credit_note_number_prefix\":\"string\",\"credit_note_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"total_quantity\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"credit_note_number_prefix\":\"string\",\"credit_note_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"total_quantity\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_credit_note\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"credit_note_number_prefix\":\"string\",\"credit_note_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"original_invoice_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"total_quantity\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"credit_note_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"credit_note_number_prefix\": \"string\",\n \"credit_note_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_credit_notes/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_credit_note: {\n contact_id: 'string',\n date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n credit_note_number_prefix: 'string',\n credit_note_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n original_invoice_date: '2019-08-24',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n total_quantity: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n credit_note_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n quantity: 0.1,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_credit_note\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"credit_note_number_prefix\\\":\\\"string\\\",\\\"credit_note_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"original_invoice_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"credit_note_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/sales_credit_notes/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D\"\n\npayload = {\"sales_credit_note\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"credit_note_number_prefix\": \"string\",\n \"credit_note_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"original_invoice_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"credit_note_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Voids a Sales Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Credit Note Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "void_reason", "description": "The reason the Sales Credit Note is being voided (required unless status is DRAFT).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Voids a Sales Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNote" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Sales Credit Notes" ], "operationId": "deleteSalesCreditNotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url 'https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE 'https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/sales_credit_notes/%7Bkey%7D?void_reason=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D\"\n\nquerystring = {\"void_reason\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"DELETE\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/sales_credit_notes/{key}/release": { "post": { "summary": "Releases a Sales Credit Note", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Credit Note Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Releases a Sales Credit Note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNote" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "credit_note_number_prefix": "string", "credit_note_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "original_invoice_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_quantity": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "credit_note_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_reconciled": true, "migrated": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Sales Credit Notes" ], "operationId": "postSalesCreditNotesKeyRelease", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http POST https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release\",\n \"method\": \"POST\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_credit_notes/%7Bkey%7D/release\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release\");\nvar request = new RestRequest(Method.POST);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"POST\", \"/v3.1/sales_credit_notes/%7Bkey%7D/release\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_credit_notes/%7Bkey%7D/release\"\n\nresponse = requests.request(\"POST\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/sales_estimates": { "get": { "summary": "Returns all Sales Estimates", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "search", "description": "Use this to filter by the estimate reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Sales Estimates dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Sales Estimates dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Sales Estimates 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Sales Estimates by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Sales Estimates per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Sales Estimates", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Estimates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Sales Estimates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesEstimate" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "estimate_number_prefix": "string", "estimate_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "estimate_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } ] } } } } } }, "tags": [ "Sales Estimates" ], "operationId": "getSalesEstimates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_estimates?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_estimates\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Sales Estimate", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSalesEstimates" }, "examples": { "Request example": { "value": { "sales_estimate": { "contact_id": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "estimate_number_prefix": "string", "estimate_number": "string", "contact_name": "string", "contact_reference": "string", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "invoice_id": "string", "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "estimate_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Sales Estimate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesEstimate" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "estimate_number_prefix": "string", "estimate_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "estimate_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } } } } } } }, "tags": [ "Sales Estimates" ], "operationId": "postSalesEstimates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/sales_estimates \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_estimate\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"estimate_number_prefix\":\"string\",\"estimate_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"estimate_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_estimate\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"estimate_number_prefix\":\"string\",\"estimate_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"estimate_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/sales_estimates \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_estimate\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"estimate_number_prefix\":\"string\",\"estimate_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"estimate_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_estimates", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_estimate\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"estimate_number_prefix\": \"string\",\n \"estimate_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"estimate_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/sales_estimates\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_estimates\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_estimates\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_estimate: {\n contact_id: 'string',\n date: '2019-08-24',\n expiry_date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n estimate_number_prefix: 'string',\n estimate_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_quantity: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n invoice_id: 'string',\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n estimate_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_estimates\"),\n Content = new StringContent(\"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_estimates\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/sales_estimates\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_estimates\"\n\npayload = {\"sales_estimate\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"estimate_number_prefix\": \"string\",\n \"estimate_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"estimate_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/sales_estimates/{key}": { "get": { "summary": "Returns a Sales Estimate", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Estimate Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Sales Estimate (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Estimate (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Sales Estimate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesEstimate" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "estimate_number_prefix": "string", "estimate_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "estimate_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } } } } } } }, "tags": [ "Sales Estimates" ], "operationId": "getSalesEstimatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_estimates/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Sales Estimate", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Estimate Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putSalesEstimates" }, "examples": { "Request example": { "value": { "sales_estimate": { "contact_id": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "estimate_number_prefix": "string", "estimate_number": "string", "contact_name": "string", "contact_reference": "string", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "invoice_id": "string", "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "estimate_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Sales Estimate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesEstimate" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "estimate_number_prefix": "string", "estimate_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "estimate_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } } } } } } }, "tags": [ "Sales Estimates" ], "operationId": "putSalesEstimatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_estimate\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"estimate_number_prefix\":\"string\",\"estimate_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"estimate_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_estimate\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"estimate_number_prefix\":\"string\",\"estimate_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"estimate_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_estimate\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"estimate_number_prefix\":\"string\",\"estimate_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"estimate_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_estimate\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"estimate_number_prefix\": \"string\",\n \"estimate_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"estimate_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_estimates/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_estimate: {\n contact_id: 'string',\n date: '2019-08-24',\n expiry_date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n estimate_number_prefix: 'string',\n estimate_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_quantity: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n invoice_id: 'string',\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n estimate_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_estimate\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"estimate_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"estimate_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/sales_estimates/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\"\n\npayload = {\"sales_estimate\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"estimate_number_prefix\": \"string\",\n \"estimate_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"estimate_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Sales Estimate", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Estimate Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Sales Estimate" } }, "tags": [ "Sales Estimates" ], "operationId": "deleteSalesEstimatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_estimates/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/sales_estimates/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_estimates/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/sales_invoices": { "get": { "summary": "Returns all Sales Invoices", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "search", "description": "Use this to filter by the invoice reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Sales Invoices dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Sales Invoices dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Sales Invoices changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Sales Invoices 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Sales Invoices by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "generate_filter_url", "description": "Use this to generate an api_filter_url to view a collection of filtered items in the application", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "copilot_vat_back_url", "description": "Return url to copilot vat page", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Sales Invoices per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Sales Invoices", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Invoices (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date, due_date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Sales Invoices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoice" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "recurring_invoice": { "id": "string", "displayed_as": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "original_quote_estimate": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrective_reason_code": { "id": "string", "displayed_as": "string", "$path": "string" }, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "details": "string", "tax_reconciled": true } ], "tax_reconciled": true, "migrated": true } ] } } } } } }, "tags": [ "Sales Invoices" ], "operationId": "getSalesInvoices", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_invoices?show_payments_allocations=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_invoices\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"contact_id\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"generate_filter_url\":\"SOME_BOOLEAN_VALUE\",\"copilot_vat_back_url\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Sales Invoice", "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 `Sales`: Full Access, Restricted Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSalesInvoices" }, "examples": { "Request example": { "value": { "sales_invoice": { "contact_id": "string", "date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "due_date": "2019-08-24", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "original_quote_estimate_id": "string", "tax_address_region_id": "string", "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "recurring_invoice": { "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "invoice_lines": [ { "description": "string", "ledger_account_id": "string", "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "quantity": 0.1, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Sales Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoice" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "recurring_invoice": { "id": "string", "displayed_as": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "original_quote_estimate": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrective_reason_code": { "id": "string", "displayed_as": "string", "$path": "string" }, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "details": "string", "tax_reconciled": true } ], "tax_reconciled": true, "migrated": true } } } } } } }, "tags": [ "Sales Invoices" ], "operationId": "postSalesInvoices", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/sales_invoices \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"invoice_number_prefix\":\"string\",\"invoice_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"due_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"original_quote_estimate_id\":\"string\",\"tax_address_region_id\":\"string\",\"delivery_performance_date\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"recurring_invoice\":{\"frequency\":0,\"on_week_day\":0,\"on_day_number\":0,\"recurrence_type\":\"string\",\"recurrence_status_identifier\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"invoice_number_prefix\":\"string\",\"invoice_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"due_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"original_quote_estimate_id\":\"string\",\"tax_address_region_id\":\"string\",\"delivery_performance_date\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"recurring_invoice\":{\"frequency\":0,\"on_week_day\":0,\"on_day_number\":0,\"recurrence_type\":\"string\",\"recurrence_status_identifier\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/sales_invoices \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"invoice_number_prefix\":\"string\",\"invoice_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"due_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"original_quote_estimate_id\":\"string\",\"tax_address_region_id\":\"string\",\"delivery_performance_date\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"recurring_invoice\":{\"frequency\":0,\"on_week_day\":0,\"on_day_number\":0,\"recurrence_type\":\"string\",\"recurrence_status_identifier\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_invoices", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"invoice_number_prefix\": \"string\",\n \"invoice_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"due_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"original_quote_estimate_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"delivery_performance_date\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"recurring_invoice\": {\n \"frequency\": 0,\n \"on_week_day\": 0,\n \"on_day_number\": 0,\n \"recurrence_type\": \"string\",\n \"recurrence_status_identifier\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/sales_invoices\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_invoices\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_invoices\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_invoice: {\n contact_id: 'string',\n date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n invoice_number_prefix: 'string',\n invoice_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n due_date: '2019-08-24',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_quantity: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n original_quote_estimate_id: 'string',\n tax_address_region_id: 'string',\n delivery_performance_date: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n recurring_invoice: {\n frequency: 0,\n on_week_day: 0,\n on_day_number: 0,\n recurrence_type: 'string',\n recurrence_status_identifier: 'string'\n },\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n invoice_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n quantity: 0.1,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_invoices\"),\n Content = new StringContent(\"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_invoices\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/sales_invoices\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_invoices\"\n\npayload = {\"sales_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"invoice_number_prefix\": \"string\",\n \"invoice_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"due_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"original_quote_estimate_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"delivery_performance_date\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"recurring_invoice\": {\n \"frequency\": 0,\n \"on_week_day\": 0,\n \"on_day_number\": 0,\n \"recurrence_type\": \"string\",\n \"recurrence_status_identifier\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/sales_invoices/{key}": { "get": { "summary": "Returns a Sales Invoice", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Invoice Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "show_corrections", "description": "Use this to show the artefact's associated corrections", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Sales Invoice (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "mark_as_sent", "description": "Use this to mark/not mark the artefact as sent. Defaulted to 'true'.", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "show_recurring_invoice", "description": "Use this to show the artefact's associated recurring invoice template if present", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Invoice (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Sales Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoice" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "recurring_invoice": { "id": "string", "displayed_as": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "original_quote_estimate": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrective_reason_code": { "id": "string", "displayed_as": "string", "$path": "string" }, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "details": "string", "tax_reconciled": true } ], "tax_reconciled": true, "migrated": true } } } } } } }, "tags": [ "Sales Invoices" ], "operationId": "getSalesInvoicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_invoices/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&show_corrections=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&mark_as_sent=SOME_BOOLEAN_VALUE&show_recurring_invoice=SOME_BOOLEAN_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"show_corrections\":\"SOME_BOOLEAN_VALUE\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"mark_as_sent\":\"SOME_BOOLEAN_VALUE\",\"show_recurring_invoice\":\"SOME_BOOLEAN_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Sales Invoice", "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 `Sales`: Full Access, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Invoice Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putSalesInvoices" }, "examples": { "Request example": { "value": { "sales_invoice": { "contact_id": "string", "date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "due_date": "2019-08-24", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "original_quote_estimate_id": "string", "tax_address_region_id": "string", "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "recurring_invoice": { "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "invoice_lines": [ { "description": "string", "ledger_account_id": "string", "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "quantity": 0.1, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Sales Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoice" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "recurring_invoice": { "id": "string", "displayed_as": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "original_quote_estimate": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrective_reason_code": { "id": "string", "displayed_as": "string", "$path": "string" }, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "details": "string", "tax_reconciled": true } ], "tax_reconciled": true, "migrated": true } } } } } } }, "tags": [ "Sales Invoices" ], "operationId": "putSalesInvoicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"invoice_number_prefix\":\"string\",\"invoice_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"due_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"original_quote_estimate_id\":\"string\",\"tax_address_region_id\":\"string\",\"delivery_performance_date\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"recurring_invoice\":{\"frequency\":0,\"on_week_day\":0,\"on_day_number\":0,\"recurrence_type\":\"string\",\"recurrence_status_identifier\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"invoice_number_prefix\":\"string\",\"invoice_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"due_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"original_quote_estimate_id\":\"string\",\"tax_address_region_id\":\"string\",\"delivery_performance_date\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"recurring_invoice\":{\"frequency\":0,\"on_week_day\":0,\"on_day_number\":0,\"recurrence_type\":\"string\",\"recurrence_status_identifier\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_invoice\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"cis_applicable_amount\":0.1,\"base_currency_cis_applicable_amount\":0.1,\"total_after_cis_deduction\":0.1,\"base_currency_total_after_cis_deduction\":0.1,\"invoice_number_prefix\":\"string\",\"invoice_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"due_date\":\"2019-08-24\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"original_quote_estimate_id\":\"string\",\"tax_address_region_id\":\"string\",\"delivery_performance_date\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"recurring_invoice\":{\"frequency\":0,\"on_week_day\":0,\"on_day_number\":0,\"recurrence_type\":\"string\",\"recurrence_status_identifier\":\"string\"},\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"invoice_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"quantity\":0.1,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"invoice_number_prefix\": \"string\",\n \"invoice_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"due_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"original_quote_estimate_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"delivery_performance_date\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"recurring_invoice\": {\n \"frequency\": 0,\n \"on_week_day\": 0,\n \"on_day_number\": 0,\n \"recurrence_type\": \"string\",\n \"recurrence_status_identifier\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_invoices/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_invoice: {\n contact_id: 'string',\n date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n cis_applicable_amount: 0.1,\n base_currency_cis_applicable_amount: 0.1,\n total_after_cis_deduction: 0.1,\n base_currency_total_after_cis_deduction: 0.1,\n invoice_number_prefix: 'string',\n invoice_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n due_date: '2019-08-24',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_quantity: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n original_quote_estimate_id: 'string',\n tax_address_region_id: 'string',\n delivery_performance_date: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n recurring_invoice: {\n frequency: 0,\n on_week_day: 0,\n on_day_number: 0,\n recurrence_type: 'string',\n recurrence_status_identifier: 'string'\n },\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n invoice_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n quantity: 0.1,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_invoice\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"cis_applicable_amount\\\":0.1,\\\"base_currency_cis_applicable_amount\\\":0.1,\\\"total_after_cis_deduction\\\":0.1,\\\"base_currency_total_after_cis_deduction\\\":0.1,\\\"invoice_number_prefix\\\":\\\"string\\\",\\\"invoice_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"due_date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"original_quote_estimate_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"delivery_performance_date\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"recurring_invoice\\\":{\\\"frequency\\\":0,\\\"on_week_day\\\":0,\\\"on_day_number\\\":0,\\\"recurrence_type\\\":\\\"string\\\",\\\"recurrence_status_identifier\\\":\\\"string\\\"},\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"invoice_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"quantity\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/sales_invoices/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D\"\n\npayload = {\"sales_invoice\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"cis_applicable_amount\": 0.1,\n \"base_currency_cis_applicable_amount\": 0.1,\n \"total_after_cis_deduction\": 0.1,\n \"base_currency_total_after_cis_deduction\": 0.1,\n \"invoice_number_prefix\": \"string\",\n \"invoice_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"due_date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"original_quote_estimate_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"delivery_performance_date\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"recurring_invoice\": {\n \"frequency\": 0,\n \"on_week_day\": 0,\n \"on_day_number\": 0,\n \"recurrence_type\": \"string\",\n \"recurrence_status_identifier\": \"string\"\n },\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"invoice_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"quantity\": 0.1,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Voids a Sales Invoice", "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 `Sales`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Invoice Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "void_reason", "description": "The reason the Sales Invoice is being voided (required unless status is DRAFT).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Voids a Sales Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoice" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "recurring_invoice": { "id": "string", "displayed_as": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "original_quote_estimate": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrective_reason_code": { "id": "string", "displayed_as": "string", "$path": "string" }, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "details": "string", "tax_reconciled": true } ], "tax_reconciled": true, "migrated": true } } } } } } }, "tags": [ "Sales Invoices" ], "operationId": "deleteSalesInvoicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url 'https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE 'https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/sales_invoices/%7Bkey%7D?void_reason=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D\"\n\nquerystring = {\"void_reason\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"DELETE\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/sales_invoices/{key}/release": { "post": { "summary": "Releases a Sales Invoice", "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 `Sales`: Full Access, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Invoice Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Releases a Sales Invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoice" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "is_cis": true, "cis_applicable_amount": 0.1, "base_currency_cis_applicable_amount": 0.1, "total_after_cis_deduction": 0.1, "base_currency_total_after_cis_deduction": 0.1, "has_cis_labour": true, "has_cis_materials": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "recurring_invoice": { "id": "string", "displayed_as": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "frequency": 0, "on_week_day": 0, "on_day_number": 0, "recurrence_type": "string", "recurrence_status_identifier": "string" }, "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "original_quote_estimate": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "delivery_performance_date": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrections": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "transaction": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "deleted": true, "reference": "string", "total": 0.1, "total_in_transaction_currency": 0.1, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "origin": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "due_date": "2019-08-24", "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true }, "audit_trail_id": "string", "number_of_attachments": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "deleted_at": "2019-08-24T14:15:22Z", "invoice_number_prefix": "string", "invoice_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "total_quantity": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "sent": true, "sent_by_email": true, "void_reason": "string", "invoice_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "last_paid": "2019-08-24", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "corrective_reason_code": { "id": "string", "displayed_as": "string", "$path": "string" }, "original_invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "original_invoice_number": "string", "original_invoice_date": "string", "details": "string", "tax_reconciled": true } ], "tax_reconciled": true, "migrated": true } } } } } } }, "tags": [ "Sales Invoices" ], "operationId": "postSalesInvoicesKeyRelease", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http POST https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release\",\n \"method\": \"POST\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_invoices/%7Bkey%7D/release\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release\");\nvar request = new RestRequest(Method.POST);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"POST\", \"/v3.1/sales_invoices/%7Bkey%7D/release\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_invoices/%7Bkey%7D/release\"\n\nresponse = requests.request(\"POST\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/sales_quick_entries": { "get": { "summary": "Returns all Sales Quick Entries", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "search", "description": "Use this to filter by the quick entry reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Sales Batch Entries dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Sales Batch Entries dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Sales 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Sales 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Sales Batch Entries by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Sales Batch Entries per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Sales Batch Entries", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Batch Entries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Sales Quick Entries", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QuickEntry" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "quick_entry_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "migrated": true, "trade_of_asset": true } ] } } } } } }, "tags": [ "Sales Quick Entries" ], "operationId": "getSalesQuickEntries", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_quick_entries?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&show_payments_allocations=SOME_BOOLEAN_VALUE&has_attachments=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quick_entries\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Sales Quick Entry", "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 `Sales`: Full Access, Restricted Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSalesQuickEntries" }, "examples": { "Request example": { "value": { "sales_quick_entry": { "quick_entry_type_id": "string", "date": "2019-08-24", "contact_id": "string", "reference": "string", "ledger_account_id": "string", "contact_name": "string", "contact_reference": "string", "details": "string", "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "trade_of_asset": true, "analysis_type_categories": [ { "analysis_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Sales Quick Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickEntry" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "quick_entry_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "migrated": true, "trade_of_asset": true } } } } } } }, "tags": [ "Sales Quick Entries" ], "operationId": "postSalesQuickEntries", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/sales_quick_entries \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/sales_quick_entries \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_quick_entries", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": true,\n \"analysis_type_categories\": [\n {\n \"analysis_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/sales_quick_entries\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quick_entries\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quick_entries\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_quick_entry: {\n quick_entry_type_id: 'string',\n date: '2019-08-24',\n contact_id: 'string',\n reference: 'string',\n ledger_account_id: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n details: 'string',\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n trade_of_asset: true,\n analysis_type_categories: [{analysis_type_id: 'string'}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quick_entries\"),\n Content = new StringContent(\"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quick_entries\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/sales_quick_entries\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quick_entries\"\n\npayload = {\"sales_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": True,\n \"analysis_type_categories\": [{\"analysis_type_id\": \"string\"}]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/sales_quick_entries/{key}": { "get": { "summary": "Returns a Sales Quick Entry", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Quick Entry Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "show_payments_allocations", "description": "Use this to show the artefact's payments and allocations", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Sales Batch Entry (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Batch Entry (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Sales Quick Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickEntry" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "quick_entry_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "migrated": true, "trade_of_asset": true } } } } } } }, "tags": [ "Sales Quick Entries" ], "operationId": "getSalesQuickEntriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_quick_entries/%7Bkey%7D?show_payments_allocations=SOME_BOOLEAN_VALUE&nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\"\n\nquerystring = {\"show_payments_allocations\":\"SOME_BOOLEAN_VALUE\",\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Sales Quick Entry", "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 `Sales`: Full Access, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Quick Entry Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putSalesQuickEntries" }, "examples": { "Request example": { "value": { "sales_quick_entry": { "quick_entry_type_id": "string", "date": "2019-08-24", "contact_id": "string", "reference": "string", "ledger_account_id": "string", "contact_name": "string", "contact_reference": "string", "details": "string", "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "tax_address_region_id": "string", "trade_of_asset": true, "analysis_type_categories": [ { "analysis_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Sales Quick Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickEntry" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "quick_entry_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "due_date": "2019-08-24", "reference": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" }, "payments_allocations": [ { "links": [ { "href": "string", "rel": "string", "type": "string" } ], "date": "2019-08-24", "type": "string", "reference": "string", "amount": 0.1, "discount": 0.1, "stripe_transaction_id": "string", "contact_allocation": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] }, "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "contact_payment": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true }, "displayed_as": "string", "negative_payment": true } ], "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "migrated": true, "trade_of_asset": true } } } } } } }, "tags": [ "Sales Quick Entries" ], "operationId": "putSalesQuickEntriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_quick_entry\":{\"quick_entry_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"ledger_account_id\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"tax_address_region_id\":\"string\",\"trade_of_asset\":true,\"analysis_type_categories\":[{\"analysis_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": true,\n \"analysis_type_categories\": [\n {\n \"analysis_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quick_entries/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_quick_entry: {\n quick_entry_type_id: 'string',\n date: '2019-08-24',\n contact_id: 'string',\n reference: 'string',\n ledger_account_id: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n details: 'string',\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n tax_address_region_id: 'string',\n trade_of_asset: true,\n analysis_type_categories: [{analysis_type_id: 'string'}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_quick_entry\\\":{\\\"quick_entry_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"analysis_type_categories\\\":[{\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/sales_quick_entries/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\"\n\npayload = {\"sales_quick_entry\": {\n \"quick_entry_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"ledger_account_id\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"trade_of_asset\": True,\n \"analysis_type_categories\": [{\"analysis_type_id\": \"string\"}]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Sales Quick Entry", "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 `Sales`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Quick Entry Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Sales Quick Entry" } }, "tags": [ "Sales Quick Entries" ], "operationId": "deleteSalesQuickEntriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quick_entries/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/sales_quick_entries/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quick_entries/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/sales_quotes": { "get": { "summary": "Returns all Sales Quotes", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "search", "description": "Use this to filter by the quote reference or contact name.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status_id", "description": "Use this to filter by status id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Sales Quotes dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Sales Quotes dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Sales Quotes 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Sales Quotes by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "generate_filter_url", "description": "Use this to generate an api_filter_url to view a collection of filtered items in the application", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "copilot_vat_back_url", "description": "Return url to copilot vat page", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Sales Quotes per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Sales Quotes", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Quotes (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date, expiry_date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Sales Quotes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuote" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "quote_number_prefix": "string", "quote_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "quote_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } ] } } } } } }, "tags": [ "Sales Quotes" ], "operationId": "getSalesQuotes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_quotes?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&status_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&has_attachments=SOME_BOOLEAN_VALUE&generate_filter_url=SOME_BOOLEAN_VALUE&copilot_vat_back_url=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quotes\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"status_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"generate_filter_url\":\"SOME_BOOLEAN_VALUE\",\"copilot_vat_back_url\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Sales Quote", "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 `Sales`: Full Access, Restricted Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSalesQuotes" }, "examples": { "Request example": { "value": { "sales_quote": { "contact_id": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "quote_number_prefix": "string", "quote_number": "string", "contact_name": "string", "contact_reference": "string", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "invoice_id": "string", "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "quote_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Sales Quote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "quote_number_prefix": "string", "quote_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "quote_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } } } } } } }, "tags": [ "Sales Quotes" ], "operationId": "postSalesQuotes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/sales_quotes \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_quote\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"quote_number_prefix\":\"string\",\"quote_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"quote_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_quote\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"quote_number_prefix\":\"string\",\"quote_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"quote_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/sales_quotes \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_quote\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"quote_number_prefix\":\"string\",\"quote_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"quote_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_quotes", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_quote\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"quote_number_prefix\": \"string\",\n \"quote_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"quote_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/sales_quotes\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quotes\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quotes\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_quote: {\n contact_id: 'string',\n date: '2019-08-24',\n expiry_date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n quote_number_prefix: 'string',\n quote_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_quantity: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n invoice_id: 'string',\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n quote_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quotes\"),\n Content = new StringContent(\"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quotes\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/sales_quotes\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quotes\"\n\npayload = {\"sales_quote\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"quote_number_prefix\": \"string\",\n \"quote_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"quote_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/sales_quotes/{key}": { "get": { "summary": "Returns a Sales Quote", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Quote Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Sales Quote (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Sales Quote (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Sales Quote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "quote_number_prefix": "string", "quote_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "quote_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } } } } } } }, "tags": [ "Sales Quotes" ], "operationId": "getSalesQuotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/sales_quotes/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Sales Quote", "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 `Sales`: Full Access, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Quote Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putSalesQuotes" }, "examples": { "Request example": { "value": { "sales_quote": { "contact_id": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "vat_reverse_charge": true, "destination_consignment": true, "quote_number_prefix": "string", "quote_number": "string", "contact_name": "string", "contact_reference": "string", "reference": "string", "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate_id": "string", "shipping_tax_amount": 0.1, "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "status_id": "string", "sent": true, "tax_address_region_id": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "invoice_id": "string", "main_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "delivery_address": { "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country_id": "string", "address_type_id": "string", "region": "string", "country_group_id": "string" }, "quote_lines": [ { "description": "string", "ledger_account_id": "string", "quantity": 0.1, "unit_price": 0.1, "analysis_type_categories": [ "string" ], "product_id": "string", "service_id": "string", "trade_of_asset": true, "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "eu_goods_services_type_id": "string", "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description_id": "string" } ], "tax_analysis": [ { "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Sales Quote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuote" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "editable": true, "vat_reverse_charge": true, "tax_calculation_method": "string", "destination_consignment": true, "destination_vat_rates_in_use": true, "contact": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "quote_number_prefix": "string", "quote_number": "string", "contact_name": "string", "contact_reference": "string", "date": "2019-08-24", "expiry_date": "2019-08-24", "reference": "string", "main_address_free_form": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "delivery_address_free_form": "string", "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" } }, "notes": "string", "terms_and_conditions": "string", "shipping_net_amount": 0.1, "shipping_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "shipping_tax_amount": 0.1, "shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "shipping_total_amount": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "inverse_exchange_rate": 0.1, "base_currency_shipping_net_amount": 0.1, "base_currency_shipping_tax_amount": 0.1, "base_currency_shipping_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_shipping_total_amount": 0.1, "total_quantity": 0.1, "total_discount_amount": 0.1, "base_currency_total_discount_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "payments_allocations_total_amount": 0.1, "payments_allocations_total_discount": 0.1, "total_paid": 0.1, "status": { "id": "string", "displayed_as": "string" }, "sent": true, "sent_by_email": true, "quote_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "description": "string", "product": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } }, "service": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true }, "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "trade_of_asset": true, "quantity": 0.1, "unit_price": 0.1, "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "base_currency_unit_price": 0.1, "unit_price_includes_tax": true, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1, "eu_goods_services_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "discount_amount": 0.1, "base_currency_discount_amount": 0.1, "discount_percentage": 0.1, "eu_sales_description": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "tax_analysis": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "service_amount": 0.1 } ], "detailed_tax_analysis": { "tax_rates_breakdown": { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] }, "name": "string", "percentage": 0.1, "net_amount": 0.1, "tax_amount": 0.1, "retail_tax_amount": 0.1, "total_amount": 0.1, "goods_amount": 0.1, "services_amount": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_goods_amount": 0.1, "base_currency_services_amount": 0.1 }, "total_net": 0.1, "total_tax": 0.1, "total": 0.1, "total_goods_amount": 0.1, "total_services_amount": 0.1, "base_currency_total_net": 0.1, "base_currency_total_tax": 0.1, "base_currency_total": 0.1, "base_currency_total_goods_amount": 0.1, "base_currency_total_services_amount": 0.1, "total_retailer_tax": 0.1 }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "base_currency_withholding_tax_amount": 0.1, "profit_analysis": { "total": { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 }, "line_breakdown": [ { "description": "string", "total_cost": 0.1, "total_sale": 0.1, "profit": 0.1, "profit_percentage": 0.1 } ] }, "tax_reconciled": true, "invoice": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] } } } } } } } }, "tags": [ "Sales Quotes" ], "operationId": "putSalesQuotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"sales_quote\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"quote_number_prefix\":\"string\",\"quote_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"quote_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"sales_quote\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"quote_number_prefix\":\"string\",\"quote_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"quote_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"sales_quote\":{\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"expiry_date\":\"2019-08-24\",\"vat_reverse_charge\":true,\"destination_consignment\":true,\"quote_number_prefix\":\"string\",\"quote_number\":\"string\",\"contact_name\":\"string\",\"contact_reference\":\"string\",\"reference\":\"string\",\"notes\":\"string\",\"terms_and_conditions\":\"string\",\"shipping_net_amount\":0.1,\"shipping_tax_rate_id\":\"string\",\"shipping_tax_amount\":0.1,\"shipping_total_amount\":0.1,\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"inverse_exchange_rate\":0.1,\"base_currency_shipping_net_amount\":0.1,\"base_currency_shipping_tax_amount\":0.1,\"base_currency_shipping_total_amount\":0.1,\"total_quantity\":0.1,\"total_discount_amount\":0.1,\"base_currency_total_discount_amount\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"status_id\":\"string\",\"sent\":true,\"tax_address_region_id\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"base_currency_withholding_tax_amount\":0.1,\"invoice_id\":\"string\",\"main_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"delivery_address\":{\"address_line_1\":\"string\",\"address_line_2\":\"string\",\"city\":\"string\",\"postal_code\":\"string\",\"country_id\":\"string\",\"address_type_id\":\"string\",\"region\":\"string\",\"country_group_id\":\"string\"},\"quote_lines\":[{\"description\":\"string\",\"ledger_account_id\":\"string\",\"quantity\":0.1,\"unit_price\":0.1,\"analysis_type_categories\":[\"string\"],\"product_id\":\"string\",\"service_id\":\"string\",\"trade_of_asset\":true,\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"total_amount\":0.1,\"base_currency_unit_price\":0.1,\"unit_price_includes_tax\":true,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"eu_goods_services_type_id\":\"string\",\"discount_amount\":0.1,\"base_currency_discount_amount\":0.1,\"discount_percentage\":0.1,\"eu_sales_description_id\":\"string\"}],\"tax_analysis\":[{\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"goods_amount\":0.1,\"service_amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"sales_quote\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": true,\n \"destination_consignment\": true,\n \"quote_number_prefix\": \"string\",\n \"quote_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": true,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"quote_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": true,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": true,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quotes/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n sales_quote: {\n contact_id: 'string',\n date: '2019-08-24',\n expiry_date: '2019-08-24',\n vat_reverse_charge: true,\n destination_consignment: true,\n quote_number_prefix: 'string',\n quote_number: 'string',\n contact_name: 'string',\n contact_reference: 'string',\n reference: 'string',\n notes: 'string',\n terms_and_conditions: 'string',\n shipping_net_amount: 0.1,\n shipping_tax_rate_id: 'string',\n shipping_tax_amount: 0.1,\n shipping_total_amount: 0.1,\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n inverse_exchange_rate: 0.1,\n base_currency_shipping_net_amount: 0.1,\n base_currency_shipping_tax_amount: 0.1,\n base_currency_shipping_total_amount: 0.1,\n total_quantity: 0.1,\n total_discount_amount: 0.1,\n base_currency_total_discount_amount: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n status_id: 'string',\n sent: true,\n tax_address_region_id: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n base_currency_withholding_tax_amount: 0.1,\n invoice_id: 'string',\n main_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n delivery_address: {\n address_line_1: 'string',\n address_line_2: 'string',\n city: 'string',\n postal_code: 'string',\n country_id: 'string',\n address_type_id: 'string',\n region: 'string',\n country_group_id: 'string'\n },\n quote_lines: [\n {\n description: 'string',\n ledger_account_id: 'string',\n quantity: 0.1,\n unit_price: 0.1,\n analysis_type_categories: ['string'],\n product_id: 'string',\n service_id: 'string',\n trade_of_asset: true,\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n total_amount: 0.1,\n base_currency_unit_price: 0.1,\n unit_price_includes_tax: true,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n eu_goods_services_type_id: 'string',\n discount_amount: 0.1,\n base_currency_discount_amount: 0.1,\n discount_percentage: 0.1,\n eu_sales_description_id: 'string'\n }\n ],\n tax_analysis: [\n {\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n goods_amount: 0.1,\n service_amount: 0.1\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"sales_quote\\\":{\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"expiry_date\\\":\\\"2019-08-24\\\",\\\"vat_reverse_charge\\\":true,\\\"destination_consignment\\\":true,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"quote_number\\\":\\\"string\\\",\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"terms_and_conditions\\\":\\\"string\\\",\\\"shipping_net_amount\\\":0.1,\\\"shipping_tax_rate_id\\\":\\\"string\\\",\\\"shipping_tax_amount\\\":0.1,\\\"shipping_total_amount\\\":0.1,\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"inverse_exchange_rate\\\":0.1,\\\"base_currency_shipping_net_amount\\\":0.1,\\\"base_currency_shipping_tax_amount\\\":0.1,\\\"base_currency_shipping_total_amount\\\":0.1,\\\"total_quantity\\\":0.1,\\\"total_discount_amount\\\":0.1,\\\"base_currency_total_discount_amount\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\",\\\"sent\\\":true,\\\"tax_address_region_id\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"base_currency_withholding_tax_amount\\\":0.1,\\\"invoice_id\\\":\\\"string\\\",\\\"main_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"delivery_address\\\":{\\\"address_line_1\\\":\\\"string\\\",\\\"address_line_2\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"postal_code\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"address_type_id\\\":\\\"string\\\",\\\"region\\\":\\\"string\\\",\\\"country_group_id\\\":\\\"string\\\"},\\\"quote_lines\\\":[{\\\"description\\\":\\\"string\\\",\\\"ledger_account_id\\\":\\\"string\\\",\\\"quantity\\\":0.1,\\\"unit_price\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"product_id\\\":\\\"string\\\",\\\"service_id\\\":\\\"string\\\",\\\"trade_of_asset\\\":true,\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"base_currency_unit_price\\\":0.1,\\\"unit_price_includes_tax\\\":true,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"eu_goods_services_type_id\\\":\\\"string\\\",\\\"discount_amount\\\":0.1,\\\"base_currency_discount_amount\\\":0.1,\\\"discount_percentage\\\":0.1,\\\"eu_sales_description_id\\\":\\\"string\\\"}],\\\"tax_analysis\\\":[{\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"goods_amount\\\":0.1,\\\"service_amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/sales_quotes/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\"\n\npayload = {\"sales_quote\": {\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"expiry_date\": \"2019-08-24\",\n \"vat_reverse_charge\": True,\n \"destination_consignment\": True,\n \"quote_number_prefix\": \"string\",\n \"quote_number\": \"string\",\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"reference\": \"string\",\n \"notes\": \"string\",\n \"terms_and_conditions\": \"string\",\n \"shipping_net_amount\": 0.1,\n \"shipping_tax_rate_id\": \"string\",\n \"shipping_tax_amount\": 0.1,\n \"shipping_total_amount\": 0.1,\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"inverse_exchange_rate\": 0.1,\n \"base_currency_shipping_net_amount\": 0.1,\n \"base_currency_shipping_tax_amount\": 0.1,\n \"base_currency_shipping_total_amount\": 0.1,\n \"total_quantity\": 0.1,\n \"total_discount_amount\": 0.1,\n \"base_currency_total_discount_amount\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"status_id\": \"string\",\n \"sent\": True,\n \"tax_address_region_id\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"base_currency_withholding_tax_amount\": 0.1,\n \"invoice_id\": \"string\",\n \"main_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"delivery_address\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"city\": \"string\",\n \"postal_code\": \"string\",\n \"country_id\": \"string\",\n \"address_type_id\": \"string\",\n \"region\": \"string\",\n \"country_group_id\": \"string\"\n },\n \"quote_lines\": [\n {\n \"description\": \"string\",\n \"ledger_account_id\": \"string\",\n \"quantity\": 0.1,\n \"unit_price\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"product_id\": \"string\",\n \"service_id\": \"string\",\n \"trade_of_asset\": True,\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"base_currency_unit_price\": 0.1,\n \"unit_price_includes_tax\": True,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"eu_goods_services_type_id\": \"string\",\n \"discount_amount\": 0.1,\n \"base_currency_discount_amount\": 0.1,\n \"discount_percentage\": 0.1,\n \"eu_sales_description_id\": \"string\"\n }\n ],\n \"tax_analysis\": [\n {\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"goods_amount\": 0.1,\n \"service_amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Sales Quote", "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 `Sales`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Sales Quote Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Sales Quote" } }, "tags": [ "Sales Quotes" ], "operationId": "deleteSalesQuotesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/sales_quotes/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/sales_quotes/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/sales_quotes/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/hosted_artefact_payment_settings": { "get": { "summary": "Returns all Hosted Artefact Payment Settings", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "query", "name": "object_guid", "description": "Use this to filter out hosted artefact payment settings by the guid of the object it is associated to.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Hosted Artefact Payment Settings per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Hosted Artefact Payment Settings", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Hosted Artefact Payment Settings (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Hosted Artefact Payment Settings", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HostedArtefactPaymentSetting" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "object_guid": "string", "disable_payment": true } ] } } } } } }, "tags": [ "Hosted Artefact Payment Settings" ], "operationId": "getHostedArtefactPaymentSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/hosted_artefact_payment_settings?object_guid=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings\"\n\nquerystring = {\"object_guid\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Hosted Artefact Payment Setting", "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 `Sales`: Full Access, Restricted Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postHostedArtefactPaymentSettings" }, "examples": { "Request example": { "value": { "hosted_artefact_payment_setting": { "object_guid": "string", "disable_payment": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Hosted Artefact Payment Setting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostedArtefactPaymentSetting" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "object_guid": "string", "disable_payment": true } } } } } } }, "tags": [ "Hosted Artefact Payment Settings" ], "operationId": "postHostedArtefactPaymentSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings \\\n --header 'Content-Type: application/json' \\\n --data '{\"hosted_artefact_payment_setting\":{\"object_guid\":\"string\",\"disable_payment\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"hosted_artefact_payment_setting\":{\"object_guid\":\"string\",\"disable_payment\":true}}' | \\\n http POST https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"hosted_artefact_payment_setting\":{\"object_guid\":\"string\",\"disable_payment\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"hosted_artefact_payment_setting\": {\n \"object_guid\": \"string\",\n \"disable_payment\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"hosted_artefact_payment_setting\\\":{\\\"object_guid\\\":\\\"string\\\",\\\"disable_payment\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/hosted_artefact_payment_settings\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n hosted_artefact_payment_setting: {object_guid: 'string', disable_payment: true}\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings\"),\n Content = new StringContent(\"{\\\"hosted_artefact_payment_setting\\\":{\\\"object_guid\\\":\\\"string\\\",\\\"disable_payment\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"hosted_artefact_payment_setting\\\":{\\\"object_guid\\\":\\\"string\\\",\\\"disable_payment\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"hosted_artefact_payment_setting\\\":{\\\"object_guid\\\":\\\"string\\\",\\\"disable_payment\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/hosted_artefact_payment_settings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings\"\n\npayload = {\"hosted_artefact_payment_setting\": {\n \"object_guid\": \"string\",\n \"disable_payment\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/hosted_artefact_payment_settings/{key}": { "get": { "summary": "Returns a Hosted Artefact Payment Setting", "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 `Sales`: Full Access, Read Only, Restricted Access", "parameters": [ { "in": "path", "name": "key", "description": "The Hosted Artefact Payment Setting Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Hosted Artefact Payment Setting (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Hosted Artefact Payment Setting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostedArtefactPaymentSetting" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "object_guid": "string", "disable_payment": true } } } } } } }, "tags": [ "Hosted Artefact Payment Settings" ], "operationId": "getHostedArtefactPaymentSettingsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/hosted_artefact_payment_settings/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Hosted Artefact Payment Setting", "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 `Sales`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Hosted Artefact Payment Setting Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Hosted Artefact Payment Setting" } }, "tags": [ "Hosted Artefact Payment Settings" ], "operationId": "deleteHostedArtefactPaymentSettingsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/hosted_artefact_payment_settings/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_opening_balances": { "get": { "summary": "Returns all Contact Opening Balances", "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 areas `Settings`, `Sales`, and `Purchases`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "contact_type_id", "description": "Use this to filter by contact type id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Batch Entries per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Batch Entries", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Batch Entries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contact Opening Balances", "content": { "application/json": { "examples": { "response": { "value": { "$total": 28, "$page": 1, "$next": "/contact_opening_balances?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "d2b7ed37544e444887e49f3f74482474", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/d2b7ed37544e444887e49f3f74482474" }, { "id": "5ed6ca8f15dc4556a3d09a8687e4bb24", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/5ed6ca8f15dc4556a3d09a8687e4bb24" }, { "id": "6442c8cd4f6041b0ba0be74a58e55032", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/6442c8cd4f6041b0ba0be74a58e55032" }, { "id": "bd5cddbe044a48e5828e0a97409ee006", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/bd5cddbe044a48e5828e0a97409ee006" }, { "id": "46edee13628b4215ab120478154b9673", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/46edee13628b4215ab120478154b9673" }, { "id": "e846488332684285bb1cbb43d47c1f73", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/e846488332684285bb1cbb43d47c1f73" }, { "id": "ce1bed1009df47d2a1f6f5d7741efcb6", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/ce1bed1009df47d2a1f6f5d7741efcb6" }, { "id": "fdcf1052687d4334b71ac61ddd3edaa6", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/fdcf1052687d4334b71ac61ddd3edaa6" }, { "id": "3351928d486641a0bacab1b578bbfc55", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/3351928d486641a0bacab1b578bbfc55" }, { "id": "1c033ecbe5ff410f9eb45ae523e7a4e6", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/1c033ecbe5ff410f9eb45ae523e7a4e6" } ] } } } } } } }, "tags": [ "Contact Opening Balances" ], "operationId": "getContactOpeningBalances", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&contact_type_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_opening_balances\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"contact_type_id\":\"SOME_STRING_VALUE\",\"contact_id\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Contact Opening Balance", "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 areas `Settings`, `Sales`, and `Purchases`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postContactOpeningBalances" }, "examples": { "Request example": { "value": { "contact_opening_balance": { "contact_opening_balance_type_id": "string", "date": "2019-08-24", "contact_id": "string", "reference": "string", "total_amount": 0.1, "transaction_type_id": "string", "details": "string", "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1 } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Contact Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactOpeningBalance" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "contact_opening_balance_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1 } } } } } } }, "tags": [ "Contact Opening Balances" ], "operationId": "postContactOpeningBalances", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/contact_opening_balances \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_opening_balance\":{\"contact_opening_balance_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"total_amount\":0.1,\"transaction_type_id\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_opening_balance\":{\"contact_opening_balance_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"total_amount\":0.1,\"transaction_type_id\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1}}' | \\\n http POST https://api.accounting.sage.com/v3.1/contact_opening_balances \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_opening_balance\":{\"contact_opening_balance_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"total_amount\":0.1,\"transaction_type_id\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_opening_balances", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_opening_balance\": {\n \"contact_opening_balance_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"total_amount\": 0.1,\n \"transaction_type_id\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/contact_opening_balances\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_opening_balances\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_opening_balances\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_opening_balance: {\n contact_opening_balance_type_id: 'string',\n date: '2019-08-24',\n contact_id: 'string',\n reference: 'string',\n total_amount: 0.1,\n transaction_type_id: 'string',\n details: 'string',\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_opening_balances\"),\n Content = new StringContent(\"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_opening_balances\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/contact_opening_balances\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_opening_balances\"\n\npayload = {\"contact_opening_balance\": {\n \"contact_opening_balance_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"total_amount\": 0.1,\n \"transaction_type_id\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/contact_opening_balances/{key}": { "get": { "summary": "Returns a Contact Opening Balance", "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 areas `Settings`, `Sales`, and `Purchases`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Opening Balance Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Batch Entry (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact Opening Balance", "content": { "application/json": { "examples": { "response": { "value": { "id": "6442c8cd4f6041b0ba0be74a58e55032", "displayed_as": "OB-O/BAL", "$path": "/contact_opening_balances/6442c8cd4f6041b0ba0be74a58e55032", "created_at": "2022-12-30T14:02:07Z", "updated_at": "2022-12-30T14:02:07Z", "transaction": { "id": "63c43414ea2445b9a255847d9fcb22a1", "displayed_as": "O/BAL", "$path": "/transactions/63c43414ea2445b9a255847d9fcb22a1" }, "transaction_type": { "id": "VENDOR_OPENING_BALANCE_INVOICE", "displayed_as": "Supplier OB Invoice", "$path": "/transaction_types/VENDOR_OPENING_BALANCE_INVOICE" }, "contact_opening_balance_type": { "id": "INVOICE", "displayed_as": "Invoice", "$path": "/contact_opening_balance_types/INVOICE" }, "contact": { "id": "a41acf06dbd148fd8cf32a46220e3135", "displayed_as": "Wise Electricals Ltd (WIS001)", "$path": "/contacts/a41acf06dbd148fd8cf32a46220e3135" }, "date": "2021-12-31", "reference": "O/BAL", "details": null, "net_amount": "35.01", "tax_rate": { "id": "GB_NO_TAX", "displayed_as": "No VAT", "$path": "/tax_rates/GB_NO_TAX" }, "tax_amount": "0.0", "tax_breakdown": [], "total_amount": "35.01", "currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "exchange_rate": "1.0", "base_currency_net_amount": "35.01", "base_currency_tax_amount": "0.0", "base_currency_tax_breakdown": [], "base_currency_total_amount": "35.01" } } } } } } }, "tags": [ "Contact Opening Balances" ], "operationId": "getContactOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Contact Opening Balance", "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 areas `Settings`, `Sales`, and `Purchases`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Opening Balance Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putContactOpeningBalances" }, "examples": { "Request example": { "value": { "contact_opening_balance": { "contact_opening_balance_type_id": "string", "date": "2019-08-24", "contact_id": "string", "reference": "string", "total_amount": 0.1, "transaction_type_id": "string", "details": "string", "net_amount": 0.1, "tax_rate_id": "string", "tax_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1 } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Contact Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactOpeningBalance" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "contact_opening_balance_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "details": "string", "net_amount": 0.1, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "base_currency_total_amount": 0.1 } } } } } } }, "tags": [ "Contact Opening Balances" ], "operationId": "putContactOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_opening_balance\":{\"contact_opening_balance_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"total_amount\":0.1,\"transaction_type_id\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_opening_balance\":{\"contact_opening_balance_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"total_amount\":0.1,\"transaction_type_id\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_opening_balance\":{\"contact_opening_balance_type_id\":\"string\",\"date\":\"2019-08-24\",\"contact_id\":\"string\",\"reference\":\"string\",\"total_amount\":0.1,\"transaction_type_id\":\"string\",\"details\":\"string\",\"net_amount\":0.1,\"tax_rate_id\":\"string\",\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_opening_balance\": {\n \"contact_opening_balance_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"total_amount\": 0.1,\n \"transaction_type_id\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_opening_balances/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_opening_balance: {\n contact_opening_balance_type_id: 'string',\n date: '2019-08-24',\n contact_id: 'string',\n reference: 'string',\n total_amount: 0.1,\n transaction_type_id: 'string',\n details: 'string',\n net_amount: 0.1,\n tax_rate_id: 'string',\n tax_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_opening_balance\\\":{\\\"contact_opening_balance_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"contact_id\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\",\\\"details\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_rate_id\\\":\\\"string\\\",\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/contact_opening_balances/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\"\n\npayload = {\"contact_opening_balance\": {\n \"contact_opening_balance_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"contact_id\": \"string\",\n \"reference\": \"string\",\n \"total_amount\": 0.1,\n \"transaction_type_id\": \"string\",\n \"details\": \"string\",\n \"net_amount\": 0.1,\n \"tax_rate_id\": \"string\",\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Contact Opening Balance", "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 areas `Settings`, `Sales`, and `Purchases`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Opening Balance Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Contact Opening Balance" } }, "tags": [ "Contact Opening Balances" ], "operationId": "deleteContactOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_opening_balances/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/contact_opening_balances/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_opening_balances/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_opening_balance_types": { "get": { "summary": "Returns all Contact Opening Balance Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Batch Entry Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Batch Entry Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Batch Entry Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contact Opening Balance Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 2, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "INVOICE", "displayed_as": "Invoice", "$path": "/contact_opening_balance_types/INVOICE" }, { "id": "CREDIT_NOTE", "displayed_as": "Cr Note", "$path": "/contact_opening_balance_types/CREDIT_NOTE" } ] } } } } } } }, "tags": [ "Contact Opening Balance Types" ], "operationId": "getContactOpeningBalanceTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_opening_balance_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_opening_balance_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_opening_balance_types/{key}": { "get": { "summary": "Returns a Contact Opening Balance Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Opening Balance Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Batch Entry Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact Opening Balance Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "INVOICE", "displayed_as": "Invoice", "$path": "/contact_opening_balance_types/INVOICE" } } } } } } }, "tags": [ "Contact Opening Balance Types" ], "operationId": "getContactOpeningBalanceTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_opening_balance_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_opening_balance_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/bank_opening_balances": { "get": { "summary": "Returns all Bank Opening Balances", "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 areas `Settings` and `Bank`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Bank Opening Balances 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "bank_account_id", "description": "Use this to filter by bank account id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Bank Opening Balances per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Bank Opening Balances", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Bank Opening Balances (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Bank Opening Balances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankOpeningBalance" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "debit": 0.1, "credit": 0.1 } ] } } } } } }, "tags": [ "Bank Opening Balances" ], "operationId": "getBankOpeningBalances", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&bank_account_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_opening_balances\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"bank_account_id\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Bank Opening Balance", "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 areas `Settings` and `Bank`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postBankOpeningBalances" }, "examples": { "Request example": { "value": { "bank_opening_balance": { "bank_account_id": "string", "date": "2019-08-24", "debit": 0.1, "credit": 0.1, "transaction_type_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Bank Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "debit": 0.1, "credit": 0.1 } } } } } } }, "tags": [ "Bank Opening Balances" ], "operationId": "postBankOpeningBalances", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/bank_opening_balances \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_opening_balance\":{\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"debit\":0.1,\"credit\":0.1,\"transaction_type_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_opening_balance\":{\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"debit\":0.1,\"credit\":0.1,\"transaction_type_id\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/bank_opening_balances \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_opening_balance\":{\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"debit\":0.1,\"credit\":0.1,\"transaction_type_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_opening_balances", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_opening_balance\": {\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"transaction_type_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/bank_opening_balances\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_opening_balances\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_opening_balances\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_opening_balance: {\n bank_account_id: 'string',\n date: '2019-08-24',\n debit: 0.1,\n credit: 0.1,\n transaction_type_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_opening_balances\"),\n Content = new StringContent(\"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_opening_balances\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/bank_opening_balances\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_opening_balances\"\n\npayload = {\"bank_opening_balance\": {\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"transaction_type_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/bank_opening_balances/{key}": { "get": { "summary": "Returns a Bank Opening Balance", "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 areas `Settings` and `Bank`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Opening Balance Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Bank Opening Balance (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Bank Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "debit": 0.1, "credit": 0.1 } } } } } } }, "tags": [ "Bank Opening Balances" ], "operationId": "getBankOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/bank_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Bank Opening Balance", "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 areas `Settings` and `Bank`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Opening Balance Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putBankOpeningBalances" }, "examples": { "Request example": { "value": { "bank_opening_balance": { "bank_account_id": "string", "date": "2019-08-24", "debit": 0.1, "credit": 0.1, "transaction_type_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Bank Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankOpeningBalance" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "debit": 0.1, "credit": 0.1 } } } } } } }, "tags": [ "Bank Opening Balances" ], "operationId": "putBankOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"bank_opening_balance\":{\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"debit\":0.1,\"credit\":0.1,\"transaction_type_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"bank_opening_balance\":{\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"debit\":0.1,\"credit\":0.1,\"transaction_type_id\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"bank_opening_balance\":{\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"debit\":0.1,\"credit\":0.1,\"transaction_type_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"bank_opening_balance\": {\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"transaction_type_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_opening_balances/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n bank_opening_balance: {\n bank_account_id: 'string',\n date: '2019-08-24',\n debit: 0.1,\n credit: 0.1,\n transaction_type_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"bank_opening_balance\\\":{\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"transaction_type_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/bank_opening_balances/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\"\n\npayload = {\"bank_opening_balance\": {\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"transaction_type_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Bank Opening Balance", "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 areas `Settings` and `Bank`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Bank Opening Balance Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Bank Opening Balance" } }, "tags": [ "Bank Opening Balances" ], "operationId": "deleteBankOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/bank_opening_balances/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/bank_opening_balances/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/bank_opening_balances/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/ledger_account_opening_balances": { "get": { "summary": "Returns all Ledger Account Opening Balances", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Journal Opening Balance Lines 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Journal Opening Balance Lines per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Journal Opening Balance Lines", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journal Opening Balance Lines (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Ledger Account Opening Balances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "debit": 0.1, "credit": 0.1 } ] } } } } } }, "tags": [ "Ledger Account Opening Balances" ], "operationId": "getLedgerAccountOpeningBalances", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_account_opening_balances?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Ledger Account Opening Balance", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postLedgerAccountOpeningBalances" }, "examples": { "Request example": { "value": { "ledger_account_opening_balance": { "ledger_account_id": "string", "debit": 0.1, "credit": 0.1, "details": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Ledger Account Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "debit": 0.1, "credit": 0.1 } } } } } } }, "tags": [ "Ledger Account Opening Balances" ], "operationId": "postLedgerAccountOpeningBalances", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/ledger_account_opening_balances \\\n --header 'Content-Type: application/json' \\\n --data '{\"ledger_account_opening_balance\":{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"ledger_account_opening_balance\":{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/ledger_account_opening_balances \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"ledger_account_opening_balance\":{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/ledger_account_opening_balances", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"ledger_account_opening_balance\": {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_opening_balances\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n ledger_account_opening_balance: {ledger_account_id: 'string', debit: 0.1, credit: 0.1, details: 'string'}\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances\"),\n Content = new StringContent(\"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/ledger_account_opening_balances\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances\"\n\npayload = {\"ledger_account_opening_balance\": {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/ledger_account_opening_balances/{key}": { "get": { "summary": "Returns a Ledger Account Opening Balance", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Account Opening Balance Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journal Opening Balance Line (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Ledger Account Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "debit": 0.1, "credit": 0.1 } } } } } } }, "tags": [ "Ledger Account Opening Balances" ], "operationId": "getLedgerAccountOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/ledger_account_opening_balances/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Ledger Account Opening Balance", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Account Opening Balance Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putLedgerAccountOpeningBalances" }, "examples": { "Request example": { "value": { "ledger_account_opening_balance": { "ledger_account_id": "string", "debit": 0.1, "credit": 0.1, "details": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Ledger Account Opening Balance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccountOpeningBalance" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "debit": 0.1, "credit": 0.1 } } } } } } }, "tags": [ "Ledger Account Opening Balances" ], "operationId": "putLedgerAccountOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"ledger_account_opening_balance\":{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"ledger_account_opening_balance\":{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"ledger_account_opening_balance\":{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"ledger_account_opening_balance\": {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_opening_balances/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n ledger_account_opening_balance: {ledger_account_id: 'string', debit: 0.1, credit: 0.1, details: 'string'}\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"ledger_account_opening_balance\\\":{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/ledger_account_opening_balances/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\"\n\npayload = {\"ledger_account_opening_balance\": {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Ledger Account Opening Balance", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Ledger Account Opening Balance Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Ledger Account Opening Balance" } }, "tags": [ "Ledger Account Opening Balances" ], "operationId": "deleteLedgerAccountOpeningBalancesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/ledger_account_opening_balances/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/ledger_account_opening_balances/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/ledger_account_opening_balances/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/opening_balance_journals": { "get": { "summary": "Returns all Opening Balance Journals", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Journal Opening Balances per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Journal Opening Balances", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journal Opening Balances (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Opening Balance Journals", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpeningBalanceJournal" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "reference": "string", "journal_lines": [ { "id": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "details": "string", "debit": 0.1, "credit": 0.1 } ] } ] } } } } } }, "tags": [ "Opening Balance Journals" ], "operationId": "getOpeningBalanceJournals", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/opening_balance_journals?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/opening_balance_journals\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Opening Balance Journal", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postOpeningBalanceJournals" }, "examples": { "Request example": { "value": { "opening_balance_journal": { "date": "2019-08-24", "reference": "string", "journal_lines": [ { "ledger_account_id": "string", "debit": 0.1, "credit": 0.1, "details": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Opening Balance Journal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpeningBalanceJournal" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "reference": "string", "journal_lines": [ { "id": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "details": "string", "debit": 0.1, "credit": 0.1 } ] } } } } } } }, "tags": [ "Opening Balance Journals" ], "operationId": "postOpeningBalanceJournals", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/opening_balance_journals \\\n --header 'Content-Type: application/json' \\\n --data '{\"opening_balance_journal\":{\"date\":\"2019-08-24\",\"reference\":\"string\",\"journal_lines\":[{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"opening_balance_journal\":{\"date\":\"2019-08-24\",\"reference\":\"string\",\"journal_lines\":[{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/opening_balance_journals \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"opening_balance_journal\":{\"date\":\"2019-08-24\",\"reference\":\"string\",\"journal_lines\":[{\"ledger_account_id\":\"string\",\"debit\":0.1,\"credit\":0.1,\"details\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/opening_balance_journals", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"opening_balance_journal\": {\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"journal_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/opening_balance_journals\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/opening_balance_journals\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"opening_balance_journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/opening_balance_journals\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n opening_balance_journal: {\n date: '2019-08-24',\n reference: 'string',\n journal_lines: [{ledger_account_id: 'string', debit: 0.1, credit: 0.1, details: 'string'}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/opening_balance_journals\"),\n Content = new StringContent(\"{\\\"opening_balance_journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/opening_balance_journals\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"opening_balance_journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"opening_balance_journal\\\":{\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"journal_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"debit\\\":0.1,\\\"credit\\\":0.1,\\\"details\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/opening_balance_journals\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/opening_balance_journals\"\n\npayload = {\"opening_balance_journal\": {\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"journal_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"debit\": 0.1,\n \"credit\": 0.1,\n \"details\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/opening_balance_journals/{key}": { "get": { "summary": "Returns a Opening Balance Journal", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Opening Balance Journal Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Journal Opening Balance (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Opening Balance Journal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpeningBalanceJournal" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "reference": "string", "journal_lines": [ { "id": "string", "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "details": "string", "debit": 0.1, "credit": 0.1 } ] } } } } } } }, "tags": [ "Opening Balance Journals" ], "operationId": "getOpeningBalanceJournalsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/opening_balance_journals/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Opening Balance Journal", "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory reporting`, `Products & Services`, and `Reporting`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Opening Balance Journal Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Opening Balance Journal" } }, "tags": [ "Opening Balance Journals" ], "operationId": "deleteOpeningBalanceJournalsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/opening_balance_journals/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/opening_balance_journals/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/opening_balance_journals/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_allocations": { "get": { "summary": "Returns all Contact Allocations", "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 areas `Sales`, `Purchases`, and `Contacts`: Full Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "transaction_type_id", "description": "Use this to filter by transaction type id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Allocations 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Allocations 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Allocations per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Allocations", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Allocations (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contact Allocations", "content": { "application/json": { "examples": { "response": { "value": { "$total": 46, "$page": 1, "$next": "/contact_allocations?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "343b3f50874e48f596d2114274e9cc6d", "displayed_as": "Customer Allocation - 2023-01-03", "$path": "/contact_allocations/343b3f50874e48f596d2114274e9cc6d" }, { "id": "e3049c8c01bb48ac8d6b2e435a06d4ad", "displayed_as": "Customer Allocation - 2023-01-12", "$path": "/contact_allocations/e3049c8c01bb48ac8d6b2e435a06d4ad" }, { "id": "eed2a26d984f4ebb8a9fe2d1ebacdba7", "displayed_as": "Customer Allocation - 2023-01-12", "$path": "/contact_allocations/eed2a26d984f4ebb8a9fe2d1ebacdba7" }, { "id": "e95b107743c248b78f5f88321c3c9adf", "displayed_as": "Customer Allocation - 2023-01-12", "$path": "/contact_allocations/e95b107743c248b78f5f88321c3c9adf" }, { "id": "83a7e88042594d15a5329588a57a9b89", "displayed_as": "Customer Allocation - 2023-01-12", "$path": "/contact_allocations/83a7e88042594d15a5329588a57a9b89" }, { "id": "36bf71fe59a74153a8a1bd51b3e3b3e9", "displayed_as": "Customer Allocation - 2023-01-13", "$path": "/contact_allocations/36bf71fe59a74153a8a1bd51b3e3b3e9" }, { "id": "6d907b5b418a45e28afdf2534d8b0098", "displayed_as": "Customer Allocation - 2023-01-13", "$path": "/contact_allocations/6d907b5b418a45e28afdf2534d8b0098" }, { "id": "107f7f682d4a432f9f05ed9e8786bc13", "displayed_as": "Customer Allocation - 2023-01-13", "$path": "/contact_allocations/107f7f682d4a432f9f05ed9e8786bc13" }, { "id": "c53e4b5b8ab24b35913f97ee514dcda8", "displayed_as": "Customer Allocation - 2023-01-13", "$path": "/contact_allocations/c53e4b5b8ab24b35913f97ee514dcda8" }, { "id": "a1fc4dfed42743e8a483c8e195f93b90", "displayed_as": "Customer Allocation - 2023-01-13", "$path": "/contact_allocations/a1fc4dfed42743e8a483c8e195f93b90" } ] } } } } } } }, "tags": [ "Contact Allocations" ], "operationId": "getContactAllocations", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_allocations?contact_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_allocations\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"transaction_type_id\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Contact Allocation", "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 areas `Sales`, `Purchases`, and `Contacts`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postContactAllocations" }, "examples": { "Request example": { "value": { "contact_allocation": { "transaction_type_id": "string", "contact_id": "string", "date": "2019-08-24", "allocated_artefacts": [ { "artefact_id": "string", "amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Contact Allocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAllocation" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] } } } } } } }, "tags": [ "Contact Allocations" ], "operationId": "postContactAllocations", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/contact_allocations \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_allocation\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_allocation\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/contact_allocations \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_allocation\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_allocations", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_allocation\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/contact_allocations\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_allocations\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_allocations\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_allocation: {\n transaction_type_id: 'string',\n contact_id: 'string',\n date: '2019-08-24',\n allocated_artefacts: [{artefact_id: 'string', amount: 0.1}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_allocations\"),\n Content = new StringContent(\"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_allocations\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/contact_allocations\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_allocations\"\n\npayload = {\"contact_allocation\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/contact_allocations/{key}": { "get": { "summary": "Returns a Contact Allocation", "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 areas `Sales`, `Purchases`, and `Contacts`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Allocation Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Allocation (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact Allocation", "content": { "application/json": { "examples": { "response": { "value": { "id": "c945a9031efd4e84812c9d130bbcf8d1", "displayed_as": "Customer Allocation - 2024-04-05", "$path": "/contact_allocations/c945a9031efd4e84812c9d130bbcf8d1", "created_at": "2024-04-05T10:30:00Z", "updated_at": "2024-04-05T10:30:00Z", "links": [ { "href": "https://accounts-extra.sageone.com/advanced_uk/customer_allocations/630611028", "rel": "alternate", "type": "text/html" } ], "transaction": { "id": "e5deb228b45743b8a80c5ad2e92f1620", "displayed_as": null, "$path": "/transactions/e5deb228b45743b8a80c5ad2e92f1620" }, "transaction_type": { "id": "CUSTOMER_ALLOCATION", "displayed_as": "Customer Allocation", "$path": "/transaction_types/CUSTOMER_ALLOCATION" }, "date": "2024-04-05", "contact": { "id": "521229b29af04f3682d85b0d43ef5361", "displayed_as": "ABS Garages Ltd (ABS001)", "$path": "/contacts/521229b29af04f3682d85b0d43ef5361" }, "allocated_artefacts": [ { "id": "fd835473cef14633af2e60101e458ab9", "artefact": { "id": "d88b0079361b4b37a3d6b4e6b41b2775", "displayed_as": "SI-355", "$path": "/sales_invoices/d88b0079361b4b37a3d6b4e6b41b2775", "links": [ { "href": "https://accounts-extra.sageone.com/invoicing/sales_invoices/d88b0079361b4b37a3d6b4e6b41b2775", "rel": "alternate", "type": "text/html" }, { "href": "https://accounts-extra.sageone.com/advanced_uk/online_payment/gb173d7da32bb99625b4af278582cfb9378e044f8ccfd5785c4e87d5042e4533c3ead35d0f8e34be8bec3cf0518a83a2991eb630b95f5841abd802a6ad930900da934bd5b6457935bf50f713539c54f5f4f063fde090e825cdefbc10b3c12d346bcf49ec8afe6f127d26948100a5583541", "rel": "bookmark", "type": "text/html" } ] }, "amount": "20.0" }, { "id": "14511ba50f2a49f1a2bc9765890f741a", "artefact": { "id": "cc31d97b43de4f9d9aaf718b7d81fa65", "displayed_as": "ABS Garages payment", "$path": "/contact_payments/abf85666183b4518af9639bff387b6d8", "links": [ { "href": null, "rel": "alternate", "type": "text/html" } ] }, "amount": "-20.0" } ] } } } } } } }, "tags": [ "Contact Allocations" ], "operationId": "getContactAllocationsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_allocations/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Contact Allocation", "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 areas `Sales`, `Purchases`, and `Contacts`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Allocation Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putContactAllocations" }, "examples": { "Request example": { "value": { "contact_allocation": { "transaction_type_id": "string", "contact_id": "string", "date": "2019-08-24", "allocated_artefacts": [ { "artefact_id": "string", "amount": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Contact Allocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAllocation" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "date": "2019-08-24", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1 } ] } } } } } } }, "tags": [ "Contact Allocations" ], "operationId": "putContactAllocationsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_allocation\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_allocation\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_allocation\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_allocation\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_allocations/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_allocation: {\n transaction_type_id: 'string',\n contact_id: 'string',\n date: '2019-08-24',\n allocated_artefacts: [{artefact_id: 'string', amount: 0.1}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_allocation\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/contact_allocations/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\"\n\npayload = {\"contact_allocation\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Contact Allocation", "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 areas `Sales`, `Purchases`, and `Contacts`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Allocation Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Contact Allocation" } }, "tags": [ "Contact Allocations" ], "operationId": "deleteContactAllocationsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_allocations/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/contact_allocations/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_allocations/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/payment_methods": { "get": { "summary": "Returns all Payment Methods", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Payment Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Payment Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Payment Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Payment Methods", "content": { "application/json": { "examples": { "response": { "value": { "$total": 5, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "CASH", "displayed_as": "Cash", "$path": "/payment_methods/CASH" }, { "id": "CHECK", "displayed_as": "Cheque", "$path": "/payment_methods/CHECK" }, { "id": "ELECTRONIC", "displayed_as": "Electronic", "$path": "/payment_methods/ELECTRONIC" }, { "id": "CREDIT_DEBIT", "displayed_as": "Credit/Debit Card", "$path": "/payment_methods/CREDIT_DEBIT" }, { "id": "ONLINE_PAYMENT", "displayed_as": "PayPal", "$path": "/payment_methods/ONLINE_PAYMENT" } ] } } } } } } }, "tags": [ "Payment Methods" ], "operationId": "getPaymentMethods", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/payment_methods?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/payment_methods\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/payment_methods/{key}": { "get": { "summary": "Returns a Payment Method", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Payment Method Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Payment Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Payment Method", "content": { "application/json": { "examples": { "response": { "value": { "id": "CREDIT_DEBIT", "displayed_as": "Credit/Debit Card", "$path": "/payment_methods/CREDIT_DEBIT" } } } } } } }, "tags": [ "Payment Methods" ], "operationId": "getPaymentMethodsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/payment_methods/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/payment_methods/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/contact_payments": { "get": { "summary": "Returns all Contact Payments", "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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "bank_account_id", "description": "Use this to filter by bank account id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "transaction_type_id", "description": "Use this to filter by transaction type id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Artefact Payments 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Artefact Payments 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Artefact Payments dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Artefact Payments dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Artefact Payments per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Artefact Payments", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Artefact Payments (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Contact Payments", "content": { "application/json": { "examples": { "response": { "value": { "$total": 192, "$page": 1, "$next": "/contact_payments?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "125fd526b6ec4fba8c416ea8ab06b1da", "displayed_as": null, "$path": "/contact_payments/125fd526b6ec4fba8c416ea8ab06b1da" }, { "id": "a4f8af3a16fb46cf9ac0654bf9155314", "displayed_as": null, "$path": "/contact_payments/a4f8af3a16fb46cf9ac0654bf9155314" }, { "id": "d41e9e5e2ef04406990d684414fc5c18", "displayed_as": null, "$path": "/contact_payments/d41e9e5e2ef04406990d684414fc5c18" }, { "id": "8e5ece9d44fd463dae36d3653ed2ef65", "displayed_as": null, "$path": "/contact_payments/8e5ece9d44fd463dae36d3653ed2ef65" }, { "id": "24596ea28f9b4fa9a014caf8c80ff17b", "displayed_as": null, "$path": "/contact_payments/24596ea28f9b4fa9a014caf8c80ff17b" }, { "id": "61bcebf5f08c4cb6a71d61e8002032fe", "displayed_as": null, "$path": "/contact_payments/61bcebf5f08c4cb6a71d61e8002032fe" }, { "id": "661afa4f4a8640a9b520e5d7895b7688", "displayed_as": null, "$path": "/contact_payments/661afa4f4a8640a9b520e5d7895b7688" }, { "id": "bd9fec37fb1f4b6fac9fb0c68af14052", "displayed_as": null, "$path": "/contact_payments/bd9fec37fb1f4b6fac9fb0c68af14052" }, { "id": "e07e0ac07b734486b29c9da163dcc5b8", "displayed_as": null, "$path": "/contact_payments/e07e0ac07b734486b29c9da163dcc5b8" }, { "id": "2f05ee7c5d374ce7acc1bcede906c3dd", "displayed_as": null, "$path": "/contact_payments/2f05ee7c5d374ce7acc1bcede906c3dd" } ] } } } } } } }, "tags": [ "Contact Payments" ], "operationId": "getContactPayments", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_payments?contact_id=SOME_STRING_VALUE&bank_account_id=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_payments\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"bank_account_id\":\"SOME_STRING_VALUE\",\"transaction_type_id\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Contact Payment", "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`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postContactPayments" }, "examples": { "Request example": { "value": { "contact_payment": { "transaction_type_id": "string", "contact_id": "string", "bank_account_id": "string", "date": "2019-08-24", "total_amount": 0.1, "payment_method_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "tax_rate_id": "string", "allocated_artefacts": [ { "artefact_id": "string", "amount": 0.1, "discount": 0.1 } ], "payment_on_account": { "contact_name": "string", "contact_reference": "string", "contact_id": "string", "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status_id": "string" } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Contact Payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPayment" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true } } } } } } }, "tags": [ "Contact Payments" ], "operationId": "postContactPayments", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/contact_payments \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_payment\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"payment_method_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_currency_charge\":0.1,\"reference\":\"string\",\"tax_rate_id\":\"string\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1,\"discount\":0.1}],\"payment_on_account\":{\"contact_name\":\"string\",\"contact_reference\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"outstanding_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_outstanding_amount\":0.1,\"status_id\":\"string\"}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_payment\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"payment_method_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_currency_charge\":0.1,\"reference\":\"string\",\"tax_rate_id\":\"string\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1,\"discount\":0.1}],\"payment_on_account\":{\"contact_name\":\"string\",\"contact_reference\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"outstanding_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_outstanding_amount\":0.1,\"status_id\":\"string\"}}}' | \\\n http POST https://api.accounting.sage.com/v3.1/contact_payments \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_payment\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"payment_method_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_currency_charge\":0.1,\"reference\":\"string\",\"tax_rate_id\":\"string\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1,\"discount\":0.1}],\"payment_on_account\":{\"contact_name\":\"string\",\"contact_reference\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"outstanding_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_outstanding_amount\":0.1,\"status_id\":\"string\"}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_payments", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_payment\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"payment_method_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_currency_charge\": 0.1,\n \"reference\": \"string\",\n \"tax_rate_id\": \"string\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1,\n \"discount\": 0.1\n }\n ],\n \"payment_on_account\": {\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"outstanding_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_outstanding_amount\": 0.1,\n \"status_id\": \"string\"\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/contact_payments\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_payments\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_payments\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_payment: {\n transaction_type_id: 'string',\n contact_id: 'string',\n bank_account_id: 'string',\n date: '2019-08-24',\n total_amount: 0.1,\n payment_method_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n base_currency_currency_charge: 0.1,\n reference: 'string',\n tax_rate_id: 'string',\n allocated_artefacts: [{artefact_id: 'string', amount: 0.1, discount: 0.1}],\n payment_on_account: {\n contact_name: 'string',\n contact_reference: 'string',\n contact_id: 'string',\n date: '2019-08-24',\n reference: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n outstanding_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n base_currency_outstanding_amount: 0.1,\n status_id: 'string'\n }\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_payments\"),\n Content = new StringContent(\"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_payments\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/contact_payments\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_payments\"\n\npayload = {\"contact_payment\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"payment_method_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_currency_charge\": 0.1,\n \"reference\": \"string\",\n \"tax_rate_id\": \"string\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1,\n \"discount\": 0.1\n }\n ],\n \"payment_on_account\": {\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"outstanding_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_outstanding_amount\": 0.1,\n \"status_id\": \"string\"\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/contact_payments/{key}": { "get": { "summary": "Returns a Contact Payment", "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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Payment Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Artefact Payment (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Contact Payment", "content": { "application/json": { "examples": { "response": { "value": { "id": "abf85666183b4518af9639bff387b6d8", "displayed_as": "ABS Garages payment", "$path": "/contact_payments/abf85666183b4518af9639bff387b6d8", "created_at": "2024-04-05T10:23:48Z", "updated_at": "2024-04-05T10:30:00Z", "links": [ { "href": "https://accounts-extra.sageone.com/advanced_uk/customer_income_payments/630606159", "rel": "alternate", "type": "text/html" } ], "transaction": { "id": "2052b76980c942038b9cc8ba183ea101", "displayed_as": "ABS Garages payment", "$path": "/transactions/2052b76980c942038b9cc8ba183ea101" }, "transaction_type": { "id": "CUSTOMER_RECEIPT", "displayed_as": "Customer Receipt", "$path": "/transaction_types/CUSTOMER_RECEIPT" }, "payment_method": { "id": "CREDIT_DEBIT", "displayed_as": "Credit/Debit Card", "$path": "/payment_methods/CREDIT_DEBIT" }, "contact": { "id": "521229b29af04f3682d85b0d43ef5361", "displayed_as": "ABS Garages Ltd (ABS001)", "$path": "/contacts/521229b29af04f3682d85b0d43ef5361" }, "bank_account": { "id": "19e5f9768c9542ef840ab7532e231215", "displayed_as": "Bank Account (1200)", "$path": "/bank_accounts/19e5f9768c9542ef840ab7532e231215" }, "date": "2024-04-05", "net_amount": "0.0", "tax_amount": "0.0", "total_amount": "120.0", "currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "exchange_rate": "1.0", "base_currency_net_amount": "0.0", "base_currency_tax_amount": "0.0", "base_currency_total_amount": "120.0", "base_currency_currency_charge": "0.0", "reference": "ABS Garages payment", "allocated_artefacts": [], "tax_rate": null, "payment_on_account": { "id": "cc31d97b43de4f9d9aaf718b7d81fa65", "displayed_as": "ABS Garages payment", "$path": "/contact_payments/abf85666183b4518af9639bff387b6d8", "created_at": "2024-04-05T10:23:48Z", "updated_at": "2024-04-05T10:30:00Z", "contact_name": "ABS Garages Ltd", "contact_reference": "ABS001", "contact": { "id": "521229b29af04f3682d85b0d43ef5361", "displayed_as": "ABS Garages Ltd (ABS001)", "$path": "/contacts/521229b29af04f3682d85b0d43ef5361" }, "date": "2024-04-05", "reference": "ABS Garages payment", "net_amount": "120.0", "tax_amount": "0.0", "total_amount": "120.0", "outstanding_amount": "100.0", "currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "exchange_rate": "1.0", "base_currency_net_amount": "120.0", "base_currency_tax_amount": "0.0", "base_currency_total_amount": "120.0", "base_currency_outstanding_amount": "100.0", "status": { "id": "PART_PAID", "displayed_as": "Part Paid", "$path": "/artefact_statuses/PART_PAID" } }, "editable": false } } } } } } }, "tags": [ "Contact Payments" ], "operationId": "getContactPaymentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/contact_payments/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Contact Payment", "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`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Payment Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putContactPayments" }, "examples": { "Request example": { "value": { "contact_payment": { "transaction_type_id": "string", "contact_id": "string", "bank_account_id": "string", "date": "2019-08-24", "total_amount": 0.1, "payment_method_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "tax_rate_id": "string", "allocated_artefacts": [ { "artefact_id": "string", "amount": 0.1, "discount": 0.1 } ], "payment_on_account": { "contact_name": "string", "contact_reference": "string", "contact_id": "string", "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency_id": "string", "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status_id": "string" } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Contact Payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPayment" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_currency_charge": 0.1, "reference": "string", "allocated_artefacts": [ { "id": "string", "artefact": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ] }, "amount": 0.1, "discount": 0.1 } ], "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "payment_on_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "contact_name": "string", "contact_reference": "string", "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "reference": "string", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "outstanding_amount": 0.1, "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate": 0.1, "base_currency_net_amount": 0.1, "base_currency_tax_amount": 0.1, "base_currency_total_amount": 0.1, "base_currency_outstanding_amount": 0.1, "status": { "id": "string", "displayed_as": "string", "$path": "string" } }, "editable": true } } } } } } }, "tags": [ "Contact Payments" ], "operationId": "putContactPaymentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"contact_payment\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"payment_method_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_currency_charge\":0.1,\"reference\":\"string\",\"tax_rate_id\":\"string\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1,\"discount\":0.1}],\"payment_on_account\":{\"contact_name\":\"string\",\"contact_reference\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"outstanding_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_outstanding_amount\":0.1,\"status_id\":\"string\"}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"contact_payment\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"payment_method_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_currency_charge\":0.1,\"reference\":\"string\",\"tax_rate_id\":\"string\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1,\"discount\":0.1}],\"payment_on_account\":{\"contact_name\":\"string\",\"contact_reference\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"outstanding_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_outstanding_amount\":0.1,\"status_id\":\"string\"}}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"contact_payment\":{\"transaction_type_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"payment_method_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_currency_charge\":0.1,\"reference\":\"string\",\"tax_rate_id\":\"string\",\"allocated_artefacts\":[{\"artefact_id\":\"string\",\"amount\":0.1,\"discount\":0.1}],\"payment_on_account\":{\"contact_name\":\"string\",\"contact_reference\":\"string\",\"contact_id\":\"string\",\"date\":\"2019-08-24\",\"reference\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"total_amount\":0.1,\"outstanding_amount\":0.1,\"currency_id\":\"string\",\"exchange_rate\":0.1,\"base_currency_net_amount\":0.1,\"base_currency_tax_amount\":0.1,\"base_currency_total_amount\":0.1,\"base_currency_outstanding_amount\":0.1,\"status_id\":\"string\"}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"contact_payment\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"payment_method_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_currency_charge\": 0.1,\n \"reference\": \"string\",\n \"tax_rate_id\": \"string\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1,\n \"discount\": 0.1\n }\n ],\n \"payment_on_account\": {\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"outstanding_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_outstanding_amount\": 0.1,\n \"status_id\": \"string\"\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_payments/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n contact_payment: {\n transaction_type_id: 'string',\n contact_id: 'string',\n bank_account_id: 'string',\n date: '2019-08-24',\n total_amount: 0.1,\n payment_method_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n base_currency_currency_charge: 0.1,\n reference: 'string',\n tax_rate_id: 'string',\n allocated_artefacts: [{artefact_id: 'string', amount: 0.1, discount: 0.1}],\n payment_on_account: {\n contact_name: 'string',\n contact_reference: 'string',\n contact_id: 'string',\n date: '2019-08-24',\n reference: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n total_amount: 0.1,\n outstanding_amount: 0.1,\n currency_id: 'string',\n exchange_rate: 0.1,\n base_currency_net_amount: 0.1,\n base_currency_tax_amount: 0.1,\n base_currency_total_amount: 0.1,\n base_currency_outstanding_amount: 0.1,\n status_id: 'string'\n }\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"contact_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"payment_method_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_currency_charge\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"allocated_artefacts\\\":[{\\\"artefact_id\\\":\\\"string\\\",\\\"amount\\\":0.1,\\\"discount\\\":0.1}],\\\"payment_on_account\\\":{\\\"contact_name\\\":\\\"string\\\",\\\"contact_reference\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"reference\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"total_amount\\\":0.1,\\\"outstanding_amount\\\":0.1,\\\"currency_id\\\":\\\"string\\\",\\\"exchange_rate\\\":0.1,\\\"base_currency_net_amount\\\":0.1,\\\"base_currency_tax_amount\\\":0.1,\\\"base_currency_total_amount\\\":0.1,\\\"base_currency_outstanding_amount\\\":0.1,\\\"status_id\\\":\\\"string\\\"}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/contact_payments/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\"\n\npayload = {\"contact_payment\": {\n \"transaction_type_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"payment_method_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_currency_charge\": 0.1,\n \"reference\": \"string\",\n \"tax_rate_id\": \"string\",\n \"allocated_artefacts\": [\n {\n \"artefact_id\": \"string\",\n \"amount\": 0.1,\n \"discount\": 0.1\n }\n ],\n \"payment_on_account\": {\n \"contact_name\": \"string\",\n \"contact_reference\": \"string\",\n \"contact_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"reference\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"total_amount\": 0.1,\n \"outstanding_amount\": 0.1,\n \"currency_id\": \"string\",\n \"exchange_rate\": 0.1,\n \"base_currency_net_amount\": 0.1,\n \"base_currency_tax_amount\": 0.1,\n \"base_currency_total_amount\": 0.1,\n \"base_currency_outstanding_amount\": 0.1,\n \"status_id\": \"string\"\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Contact Payment", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Contact Payment Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Contact Payment" } }, "tags": [ "Contact Payments" ], "operationId": "deleteContactPaymentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/contact_payments/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/contact_payments/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/contact_payments/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/other_payments": { "get": { "summary": "Returns all Other Payments", "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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "bank_account_id", "description": "Use this to filter by bank account id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Payments 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Payments dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "has_attachments", "description": "Use this to filter Payments by whether they have attachments or not", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Payments dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "transaction_type_id", "description": "Use this to filter by transaction type id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Payments 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Payments per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Payments", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Payments (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`).\nAvailable attributes are:\ncreated_at, updated_at, date\n\nExample: `sort=created_at` or `sort=created_at:desc`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Other Payments", "content": { "application/json": { "examples": { "response": { "value": { "$total": 203, "$page": 1, "$next": "/other_payments?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "184f5ef4e3b54c1fa62787c70e4410d1", "displayed_as": "56956", "$path": "/other_payments/184f5ef4e3b54c1fa62787c70e4410d1" }, { "id": "c1b3a4f6173e455bb753199443bac8e2", "displayed_as": "656678", "$path": "/other_payments/c1b3a4f6173e455bb753199443bac8e2" }, { "id": "60bb9789bd5c4f55a612c999596d6ec6", "displayed_as": "656679", "$path": "/other_payments/60bb9789bd5c4f55a612c999596d6ec6" }, { "id": "ddfcb102f0c04e2aa50af428be73c365", "displayed_as": "656680", "$path": "/other_payments/ddfcb102f0c04e2aa50af428be73c365" }, { "id": "ed7f144bea1d4d86a9d25bee6d97fe9e", "displayed_as": "656681", "$path": "/other_payments/ed7f144bea1d4d86a9d25bee6d97fe9e" }, { "id": "6ca8b8870393426bab0595deaee44a3f", "displayed_as": "656869", "$path": "/other_payments/6ca8b8870393426bab0595deaee44a3f" }, { "id": "ae41fb5720334460a442a0906ced939f", "displayed_as": "568953", "$path": "/other_payments/ae41fb5720334460a442a0906ced939f" }, { "id": "b1eb0a6f9767491c98aa7f89573132fd", "displayed_as": "1", "$path": "/other_payments/b1eb0a6f9767491c98aa7f89573132fd" }, { "id": "c864c723552b42de982c39e57bd2799c", "displayed_as": "1", "$path": "/other_payments/c864c723552b42de982c39e57bd2799c" }, { "id": "31e5ca2ca2df4fb2b6834392f979aa11", "displayed_as": "SED", "$path": "/other_payments/31e5ca2ca2df4fb2b6834392f979aa11" } ] } } } } } } }, "tags": [ "Other Payments" ], "operationId": "getOtherPayments", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/other_payments?bank_account_id=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&deleted_since=2015-10-27T16%3A24%3A52Z&from_date=SOME_STRING_VALUE&has_attachments=SOME_BOOLEAN_VALUE&to_date=SOME_STRING_VALUE&transaction_type_id=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/other_payments\"\n\nquerystring = {\"bank_account_id\":\"SOME_STRING_VALUE\",\"contact_id\":\"SOME_STRING_VALUE\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"from_date\":\"SOME_STRING_VALUE\",\"has_attachments\":\"SOME_BOOLEAN_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"transaction_type_id\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"sort\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Other Payment", "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`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postOtherPayments" }, "examples": { "Request example": { "value": { "other_payment": { "transaction_type_id": "string", "date": "2019-08-24", "total_amount": 0.1, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "payment_method_id": "string", "contact_id": "string", "bank_account_id": "string", "tax_address_region_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "reference": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "payment_lines": [ { "ledger_account_id": "string", "total_amount": 0.1, "analysis_type_categories": [ "string" ], "details": "string", "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "is_purchase_for_resale": true, "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Other Payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtherPayment" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "reference": "string", "payment_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "is_purchase_for_resale": true, "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "editable": true, "deletable": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Other Payments" ], "operationId": "postOtherPayments", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/other_payments \\\n --header 'Content-Type: application/json' \\\n --data '{\"other_payment\":{\"transaction_type_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"payment_method_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"tax_address_region_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"reference\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"payment_lines\":[{\"ledger_account_id\":\"string\",\"total_amount\":0.1,\"analysis_type_categories\":[\"string\"],\"details\":\"string\",\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"is_purchase_for_resale\":true,\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"other_payment\":{\"transaction_type_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"payment_method_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"tax_address_region_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"reference\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"payment_lines\":[{\"ledger_account_id\":\"string\",\"total_amount\":0.1,\"analysis_type_categories\":[\"string\"],\"details\":\"string\",\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"is_purchase_for_resale\":true,\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/other_payments \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"other_payment\":{\"transaction_type_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"payment_method_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"tax_address_region_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"reference\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"payment_lines\":[{\"ledger_account_id\":\"string\",\"total_amount\":0.1,\"analysis_type_categories\":[\"string\"],\"details\":\"string\",\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"is_purchase_for_resale\":true,\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/other_payments", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"other_payment\": {\n \"transaction_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": true,\n \"payment_method_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"reference\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"payment_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"total_amount\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"details\": \"string\",\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"is_purchase_for_resale\": true,\n \"trade_of_asset\": true,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/other_payments\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/other_payments\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/other_payments\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n other_payment: {\n transaction_type_id: 'string',\n date: '2019-08-24',\n total_amount: 0.1,\n base_currency_total_itc_amount: 0.1,\n total_itc_amount: 0.1,\n base_currency_total_itr_amount: 0.1,\n total_itr_amount: 0.1,\n part_recoverable: true,\n payment_method_id: 'string',\n contact_id: 'string',\n bank_account_id: 'string',\n tax_address_region_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n reference: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n payment_lines: [\n {\n ledger_account_id: 'string',\n total_amount: 0.1,\n analysis_type_categories: ['string'],\n details: 'string',\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n is_purchase_for_resale: true,\n trade_of_asset: true,\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/other_payments\"),\n Content = new StringContent(\"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/other_payments\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/other_payments\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/other_payments\"\n\npayload = {\"other_payment\": {\n \"transaction_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": True,\n \"payment_method_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"reference\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"payment_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"total_amount\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"details\": \"string\",\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"is_purchase_for_resale\": True,\n \"trade_of_asset\": True,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/other_payments/{key}": { "get": { "summary": "Returns a Other Payment", "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`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Other Payment Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "nested_attributes", "description": "Specify the attributes that you want to expose for nested entities of the Payment (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "show_analysis_types", "description": "Use this to show the line item analysis types", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Payment (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Other Payment", "content": { "application/json": { "examples": { "response": { "value": { "id": "a47292616ba743f6b111adb7d3df40d5", "displayed_as": "ABS Garages payment", "$path": "/other_payments/a47292616ba743f6b111adb7d3df40d5", "created_at": "2024-04-05T08:56:57Z", "updated_at": "2024-04-05T08:56:57Z", "transaction": { "id": "92137a7c04fd4c14b68c2da0b9b7b49f", "displayed_as": "ABS Garages payment", "$path": "/transactions/92137a7c04fd4c14b68c2da0b9b7b49f" }, "transaction_type": { "id": "OTHER_RECEIPT", "displayed_as": "Other Receipt", "$path": "/transaction_types/OTHER_RECEIPT" }, "base_currency_total_itc_amount": null, "total_itc_amount": null, "base_currency_total_itr_amount": null, "total_itr_amount": null, "part_recoverable": null, "payment_method": { "id": "CREDIT_DEBIT", "displayed_as": "Credit/Debit Card", "$path": "/payment_methods/CREDIT_DEBIT" }, "contact": { "id": "521229b29af04f3682d85b0d43ef5361", "displayed_as": "ABS Garages Ltd (ABS001)", "$path": "/contacts/521229b29af04f3682d85b0d43ef5361" }, "bank_account": { "id": "19e5f9768c9542ef840ab7532e231215", "displayed_as": "Bank Account (1200)", "$path": "/bank_accounts/19e5f9768c9542ef840ab7532e231215" }, "tax_address_region": null, "date": "2024-04-05", "net_amount": "100.0", "tax_amount": "20.0", "total_amount": "120.0", "reference": "ABS Garages payment", "payment_lines": [ { "id": "d14fcfd5ae7f445fbda2fa3965ce70b0", "displayed_as": "ABS Garages payment", "ledger_account": { "id": "7a5ecfcf884911ed84fa0252b90cda0d", "displayed_as": "Other income (4900)", "$path": "/ledger_accounts/7a5ecfcf884911ed84fa0252b90cda0d" }, "details": "ABS Garages payment", "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "net_amount": "100.0", "tax_amount": "20.0", "total_amount": "120.0", "tax_breakdown": [ { "tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "percentage": "20.0", "amount": "20.0" } ], "is_purchase_for_resale": false, "trade_of_asset": false, "gst_amount": null, "pst_amount": null, "tax_recoverable": null } ], "editable": true, "deletable": false, "withholding_tax_rate": null, "withholding_tax_amount": null } } } } } } }, "tags": [ "Other Payments" ], "operationId": "getOtherPaymentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/other_payments/%7Bkey%7D?nested_attributes=SOME_STRING_VALUE&show_analysis_types=SOME_BOOLEAN_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\"\n\nquerystring = {\"nested_attributes\":\"SOME_STRING_VALUE\",\"show_analysis_types\":\"SOME_BOOLEAN_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Other Payment", "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`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Other Payment Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putOtherPayments" }, "examples": { "Request example": { "value": { "other_payment": { "transaction_type_id": "string", "date": "2019-08-24", "total_amount": 0.1, "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "payment_method_id": "string", "contact_id": "string", "bank_account_id": "string", "tax_address_region_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "reference": "string", "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1, "payment_lines": [ { "ledger_account_id": "string", "total_amount": 0.1, "analysis_type_categories": [ "string" ], "details": "string", "tax_rate_id": "string", "net_amount": 0.1, "tax_amount": 0.1, "is_purchase_for_resale": true, "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Other Payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtherPayment" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "transaction": { "id": "string", "displayed_as": "string", "$path": "string" }, "transaction_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "base_currency_total_itc_amount": 0.1, "total_itc_amount": 0.1, "base_currency_total_itr_amount": 0.1, "total_itr_amount": 0.1, "part_recoverable": true, "payment_method": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_address_region": { "id": "string", "displayed_as": "string", "$path": "string" }, "date": "2019-08-24", "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "reference": "string", "payment_lines": [ { "id": "string", "displayed_as": "string", "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } ], "ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "details": "string", "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "net_amount": 0.1, "tax_amount": 0.1, "total_amount": 0.1, "tax_breakdown": [ { "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "percentage": 0.1, "amount": 0.1 } ], "is_purchase_for_resale": true, "trade_of_asset": true, "gst_amount": 0.1, "pst_amount": 0.1, "tax_recoverable": true } ], "editable": true, "deletable": true, "withholding_tax_rate": 0.1, "withholding_tax_amount": 0.1 } } } } } } }, "tags": [ "Other Payments" ], "operationId": "putOtherPaymentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"other_payment\":{\"transaction_type_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"payment_method_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"tax_address_region_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"reference\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"payment_lines\":[{\"ledger_account_id\":\"string\",\"total_amount\":0.1,\"analysis_type_categories\":[\"string\"],\"details\":\"string\",\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"is_purchase_for_resale\":true,\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"other_payment\":{\"transaction_type_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"payment_method_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"tax_address_region_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"reference\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"payment_lines\":[{\"ledger_account_id\":\"string\",\"total_amount\":0.1,\"analysis_type_categories\":[\"string\"],\"details\":\"string\",\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"is_purchase_for_resale\":true,\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"other_payment\":{\"transaction_type_id\":\"string\",\"date\":\"2019-08-24\",\"total_amount\":0.1,\"base_currency_total_itc_amount\":0.1,\"total_itc_amount\":0.1,\"base_currency_total_itr_amount\":0.1,\"total_itr_amount\":0.1,\"part_recoverable\":true,\"payment_method_id\":\"string\",\"contact_id\":\"string\",\"bank_account_id\":\"string\",\"tax_address_region_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"reference\":\"string\",\"withholding_tax_rate\":0.1,\"withholding_tax_amount\":0.1,\"payment_lines\":[{\"ledger_account_id\":\"string\",\"total_amount\":0.1,\"analysis_type_categories\":[\"string\"],\"details\":\"string\",\"tax_rate_id\":\"string\",\"net_amount\":0.1,\"tax_amount\":0.1,\"is_purchase_for_resale\":true,\"trade_of_asset\":true,\"gst_amount\":0.1,\"pst_amount\":0.1,\"tax_recoverable\":true}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"other_payment\": {\n \"transaction_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": true,\n \"payment_method_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"reference\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"payment_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"total_amount\": 0.1,\n \"analysis_type_categories\": [\n \"string\"\n ],\n \"details\": \"string\",\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"is_purchase_for_resale\": true,\n \"trade_of_asset\": true,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": true\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/other_payments/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n other_payment: {\n transaction_type_id: 'string',\n date: '2019-08-24',\n total_amount: 0.1,\n base_currency_total_itc_amount: 0.1,\n total_itc_amount: 0.1,\n base_currency_total_itr_amount: 0.1,\n total_itr_amount: 0.1,\n part_recoverable: true,\n payment_method_id: 'string',\n contact_id: 'string',\n bank_account_id: 'string',\n tax_address_region_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n reference: 'string',\n withholding_tax_rate: 0.1,\n withholding_tax_amount: 0.1,\n payment_lines: [\n {\n ledger_account_id: 'string',\n total_amount: 0.1,\n analysis_type_categories: ['string'],\n details: 'string',\n tax_rate_id: 'string',\n net_amount: 0.1,\n tax_amount: 0.1,\n is_purchase_for_resale: true,\n trade_of_asset: true,\n gst_amount: 0.1,\n pst_amount: 0.1,\n tax_recoverable: true\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"other_payment\\\":{\\\"transaction_type_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"total_amount\\\":0.1,\\\"base_currency_total_itc_amount\\\":0.1,\\\"total_itc_amount\\\":0.1,\\\"base_currency_total_itr_amount\\\":0.1,\\\"total_itr_amount\\\":0.1,\\\"part_recoverable\\\":true,\\\"payment_method_id\\\":\\\"string\\\",\\\"contact_id\\\":\\\"string\\\",\\\"bank_account_id\\\":\\\"string\\\",\\\"tax_address_region_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"reference\\\":\\\"string\\\",\\\"withholding_tax_rate\\\":0.1,\\\"withholding_tax_amount\\\":0.1,\\\"payment_lines\\\":[{\\\"ledger_account_id\\\":\\\"string\\\",\\\"total_amount\\\":0.1,\\\"analysis_type_categories\\\":[\\\"string\\\"],\\\"details\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\",\\\"net_amount\\\":0.1,\\\"tax_amount\\\":0.1,\\\"is_purchase_for_resale\\\":true,\\\"trade_of_asset\\\":true,\\\"gst_amount\\\":0.1,\\\"pst_amount\\\":0.1,\\\"tax_recoverable\\\":true}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/other_payments/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\"\n\npayload = {\"other_payment\": {\n \"transaction_type_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"total_amount\": 0.1,\n \"base_currency_total_itc_amount\": 0.1,\n \"total_itc_amount\": 0.1,\n \"base_currency_total_itr_amount\": 0.1,\n \"total_itr_amount\": 0.1,\n \"part_recoverable\": True,\n \"payment_method_id\": \"string\",\n \"contact_id\": \"string\",\n \"bank_account_id\": \"string\",\n \"tax_address_region_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"reference\": \"string\",\n \"withholding_tax_rate\": 0.1,\n \"withholding_tax_amount\": 0.1,\n \"payment_lines\": [\n {\n \"ledger_account_id\": \"string\",\n \"total_amount\": 0.1,\n \"analysis_type_categories\": [\"string\"],\n \"details\": \"string\",\n \"tax_rate_id\": \"string\",\n \"net_amount\": 0.1,\n \"tax_amount\": 0.1,\n \"is_purchase_for_resale\": True,\n \"trade_of_asset\": True,\n \"gst_amount\": 0.1,\n \"pst_amount\": 0.1,\n \"tax_recoverable\": True\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Other Payment", "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", "parameters": [ { "in": "path", "name": "key", "description": "The Other Payment Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Other Payment" } }, "tags": [ "Other Payments" ], "operationId": "deleteOtherPaymentsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/other_payments/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/other_payments/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/other_payments/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/unallocated_artefacts": { "get": { "summary": "Returns all Unallocated Artefacts", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "search", "description": "Use this to filter by the contact identifier.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Base Artefacts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Base Artefacts per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Base Artefacts", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Returns all Unallocated Artefacts", "content": { "application/json": { "examples": { "response": { "value": { "$total": 245, "$page": 1, "$next": "/unallocated_artefacts?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "d2b7ed37544e444887e49f3f74482474", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/d2b7ed37544e444887e49f3f74482474" }, { "id": "5ed6ca8f15dc4556a3d09a8687e4bb24", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/5ed6ca8f15dc4556a3d09a8687e4bb24" }, { "id": "6442c8cd4f6041b0ba0be74a58e55032", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/6442c8cd4f6041b0ba0be74a58e55032" }, { "id": "bd5cddbe044a48e5828e0a97409ee006", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/bd5cddbe044a48e5828e0a97409ee006" }, { "id": "46edee13628b4215ab120478154b9673", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/46edee13628b4215ab120478154b9673" }, { "id": "e846488332684285bb1cbb43d47c1f73", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/e846488332684285bb1cbb43d47c1f73" }, { "id": "ce1bed1009df47d2a1f6f5d7741efcb6", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/ce1bed1009df47d2a1f6f5d7741efcb6" }, { "id": "fdcf1052687d4334b71ac61ddd3edaa6", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/fdcf1052687d4334b71ac61ddd3edaa6" }, { "id": "3351928d486641a0bacab1b578bbfc55", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/3351928d486641a0bacab1b578bbfc55" }, { "id": "1c033ecbe5ff410f9eb45ae523e7a4e6", "displayed_as": "OB-O/BAL", "$path": "/sales_quick_entries/1c033ecbe5ff410f9eb45ae523e7a4e6" } ] } } } } } } }, "tags": [ "Unallocated Artefacts" ], "operationId": "getUnallocatedArtefacts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/unallocated_artefacts?contact_id=SOME_STRING_VALUE&search=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/unallocated_artefacts\"\n\nquerystring = {\"contact_id\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/unallocated_artefacts/{key}": { "get": { "summary": "Returns a Unallocated Artefact", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Unallocated Artefact Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Base Artefact (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an Unallocated Artefact", "content": { "application/json": { "examples": { "response": { "value": { "id": "d2b7ed37544e444887e49f3f74482474", "displayed_as": "OB-O/BAL", "$path": "/purchase_quick_entries/d2b7ed37544e444887e49f3f74482474", "links": [ { "href": "https://accounts-extra.sageone.com/settings/supplier_opening_balances", "rel": "alternate", "type": "text/html" } ] } } } } } } }, "tags": [ "Unallocated Artefacts" ], "operationId": "getUnallocatedArtefactsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/unallocated_artefacts/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/unallocated_artefacts/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/catalog_item_types": { "get": { "summary": "Returns all Catalog Item Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Catalog Item Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Catalog Item Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Catalog Item Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Catalog Item Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 3, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "STOCK_ITEM", "displayed_as": "Stock", "$path": "/catalog_item_types/STOCK_ITEM" }, { "id": "PRODUCT", "displayed_as": "Non-stock", "$path": "/catalog_item_types/PRODUCT" }, { "id": "SERVICE", "displayed_as": "Service", "$path": "/catalog_item_types/SERVICE" } ] } } } } } } }, "tags": [ "Catalog Item Types" ], "operationId": "getCatalogItemTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/catalog_item_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/catalog_item_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/catalog_item_types/{key}": { "get": { "summary": "Returns a Catalog Item Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Catalog Item Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Catalog Item Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Catalog Item Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "STOCK_ITEM", "displayed_as": "Stock", "$path": "/catalog_item_types/STOCK_ITEM" } } } } } } }, "tags": [ "Catalog Item Types" ], "operationId": "getCatalogItemTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/catalog_item_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/catalog_item_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/product_sales_price_types": { "get": { "summary": "Returns all Product Sales Price Types", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "active", "description": "Use this to only return active or inactive items", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Product Prices per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Product Prices", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Product Prices (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Product Sales Price Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 3, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "26024c3e7357462897edb896cc7084e9", "displayed_as": "Sales Price", "$path": "/product_sales_price_types/26024c3e7357462897edb896cc7084e9" }, { "id": "1d0fee218bcc425f803dc1bca63c3666", "displayed_as": "Trade", "$path": "/product_sales_price_types/1d0fee218bcc425f803dc1bca63c3666" }, { "id": "2c424fdefbe944aaa69cd1ce0c7277a3", "displayed_as": "Wholesale", "$path": "/product_sales_price_types/2c424fdefbe944aaa69cd1ce0c7277a3" } ] } } } } } } }, "tags": [ "Product Sales Price Types" ], "operationId": "getProductSalesPriceTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/product_sales_price_types?active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/product_sales_price_types\"\n\nquerystring = {\"active\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Product Sales Price Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postProductSalesPriceTypes" }, "examples": { "Request example": { "value": { "product_sales_price_type": { "name": "string", "active": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Product Sales Price Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSalesPriceType" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "active": true } } } } } } }, "tags": [ "Product Sales Price Types" ], "operationId": "postProductSalesPriceTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/product_sales_price_types \\\n --header 'Content-Type: application/json' \\\n --data '{\"product_sales_price_type\":{\"name\":\"string\",\"active\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"product_sales_price_type\":{\"name\":\"string\",\"active\":true}}' | \\\n http POST https://api.accounting.sage.com/v3.1/product_sales_price_types \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"product_sales_price_type\":{\"name\":\"string\",\"active\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/product_sales_price_types", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"product_sales_price_type\": {\n \"name\": \"string\",\n \"active\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/product_sales_price_types\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/product_sales_price_types\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/product_sales_price_types\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({product_sales_price_type: {name: 'string', active: true}}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/product_sales_price_types\"),\n Content = new StringContent(\"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/product_sales_price_types\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/product_sales_price_types\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/product_sales_price_types\"\n\npayload = {\"product_sales_price_type\": {\n \"name\": \"string\",\n \"active\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/product_sales_price_types/{key}": { "get": { "summary": "Returns a Product Sales Price Type", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Product Sales Price Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Product Price (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Product Sales Price Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "26024c3e7357462897edb896cc7084e9", "displayed_as": "Sales Price", "$path": "/product_sales_price_types/26024c3e7357462897edb896cc7084e9", "created_at": "2022-12-30T13:54:28Z", "updated_at": "2022-12-30T13:54:28Z", "name": "Sales Price", "active": true } } } } } } }, "tags": [ "Product Sales Price Types" ], "operationId": "getProductSalesPriceTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/product_sales_price_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Product Sales Price Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Product Sales Price Type Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putProductSalesPriceTypes" }, "examples": { "Request example": { "value": { "product_sales_price_type": { "name": "string", "active": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Product Sales Price Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSalesPriceType" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "active": true } } } } } } }, "tags": [ "Product Sales Price Types" ], "operationId": "putProductSalesPriceTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"product_sales_price_type\":{\"name\":\"string\",\"active\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"product_sales_price_type\":{\"name\":\"string\",\"active\":true}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"product_sales_price_type\":{\"name\":\"string\",\"active\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"product_sales_price_type\": {\n \"name\": \"string\",\n \"active\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/product_sales_price_types/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({product_sales_price_type: {name: 'string', active: true}}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"product_sales_price_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/product_sales_price_types/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\"\n\npayload = {\"product_sales_price_type\": {\n \"name\": \"string\",\n \"active\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Product Sales Price Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Product Sales Price Type Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Product Sales Price Type" } }, "tags": [ "Product Sales Price Types" ], "operationId": "deleteProductSalesPriceTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/product_sales_price_types/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/product_sales_price_types/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/product_sales_price_types/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/products": { "get": { "summary": "Returns all Products", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "search", "description": "Use this to filter by the item code or description.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Products changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Products 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "active", "description": "Use this to only return active or inactive items", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Products per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Products", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Products (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Products", "content": { "application/json": { "examples": { "response": { "value": { "$total": 108, "$page": 1, "$next": "/products?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "cf7e4478b34748ef95756e93a79e4059", "displayed_as": "Whiteboard - Drywipe (900 x 1200)", "$path": "/products/cf7e4478b34748ef95756e93a79e4059" }, { "id": "22e9e0f4b53c4512ace0af975795b46a", "displayed_as": "Whiteboard - Drywipe (1000 x 1500)", "$path": "/products/22e9e0f4b53c4512ace0af975795b46a" }, { "id": "9d1a5ae4c0d844f6a9d8336ddb2f3432", "displayed_as": "A4 Ledger Book - 5 Column", "$path": "/products/9d1a5ae4c0d844f6a9d8336ddb2f3432" }, { "id": "a4aacfc4ef3f46a2a6193b50f0fb6b07", "displayed_as": "A4 Carbon Copy Book - Triplicate", "$path": "/products/a4aacfc4ef3f46a2a6193b50f0fb6b07" }, { "id": "b86f251ec16e4697a8c22cb40d0d9f69", "displayed_as": "Shorthand Notebook - 80 Sheets", "$path": "/products/b86f251ec16e4697a8c22cb40d0d9f69" }, { "id": "b5b7ace2b80342aa9fcc26c90d8421ce", "displayed_as": "Calculator - Desktop", "$path": "/products/b5b7ace2b80342aa9fcc26c90d8421ce" }, { "id": "ccfb1cfc728e4f07839ce356bfca2ef2", "displayed_as": "Calculator - Pocket", "$path": "/products/ccfb1cfc728e4f07839ce356bfca2ef2" }, { "id": "aa56dfd1c4f144e38ddd450cb8b98e9a", "displayed_as": "Calculator - Desktop (Printing)", "$path": "/products/aa56dfd1c4f144e38ddd450cb8b98e9a" }, { "id": "04309417033d4bcc96e67ce21a304217", "displayed_as": "Calculator - Printing Rolls", "$path": "/products/04309417033d4bcc96e67ce21a304217" }, { "id": "3fff912ee06c44808b7395eb74f8a24e", "displayed_as": "AT Mini Tower Case", "$path": "/products/3fff912ee06c44808b7395eb74f8a24e" } ] } } } } } } }, "tags": [ "Products" ], "operationId": "getProducts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/products?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/products\"\n\nquerystring = {\"search\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"active\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Product", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postProducts" }, "examples": { "Request example": { "value": { "product": { "description": "string", "sales_ledger_account_id": "string", "purchase_ledger_account_id": "string", "item_code": "string", "notes": "string", "sales_tax_rate_id": "string", "usual_supplier_id": "string", "purchase_tax_rate_id": "string", "cost_price": 0.1, "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type_id": "string", "sales_prices": [ { "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Product", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Products" ], "operationId": "postProducts", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/products \\\n --header 'Content-Type: application/json' \\\n --data '{\"product\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"active\":true,\"catalog_item_type_id\":\"string\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"product\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"active\":true,\"catalog_item_type_id\":\"string\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/products \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"product\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"active\":true,\"catalog_item_type_id\":\"string\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/products", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"product\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"active\": true,\n \"catalog_item_type_id\": \"string\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": true,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/products\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/products\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/products\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n product: {\n description: 'string',\n sales_ledger_account_id: 'string',\n purchase_ledger_account_id: 'string',\n item_code: 'string',\n notes: 'string',\n sales_tax_rate_id: 'string',\n usual_supplier_id: 'string',\n purchase_tax_rate_id: 'string',\n cost_price: 0.1,\n source_guid: 'string',\n purchase_description: 'string',\n active: true,\n catalog_item_type_id: 'string',\n sales_prices: [\n {\n price_name: 'string',\n price: 0.1,\n price_includes_tax: true,\n product_sales_price_type_id: 'string'\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/products\"),\n Content = new StringContent(\"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/products\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/products\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/products\"\n\npayload = {\"product\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"active\": True,\n \"catalog_item_type_id\": \"string\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": True,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/products/{key}": { "get": { "summary": "Returns a Product", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Product Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Product (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Product", "content": { "application/json": { "examples": { "response": { "value": { "id": "aa56dfd1c4f144e38ddd450cb8b98e9a", "displayed_as": "Calculator - Desktop (Printing)", "$path": "/products/aa56dfd1c4f144e38ddd450cb8b98e9a", "created_at": "2022-12-30T14:22:52Z", "updated_at": "2022-12-30T14:22:52Z", "links": [ { "href": "https://accounts-extra.sageone.com/advanced_uk/products_services/15652647", "rel": "alternate", "type": "text/html" } ], "deletable": false, "deactivatable": true, "used_on_recurring_invoice": false, "item_code": "CALC003", "description": "Calculator - Desktop (Printing)", "notes": null, "sales_ledger_account": { "id": "7a5e37b4884911ed84fa0252b90cda0d", "displayed_as": "Sales - Products (4000)", "$path": "/ledger_accounts/7a5e37b4884911ed84fa0252b90cda0d" }, "sales_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "purchase_ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "usual_supplier": { "id": "5b5384e03d9f40609d3afbbf0d44cbb0", "displayed_as": "Wallace Office Equipment (WAL001)", "$path": "/usual_suppliers/5b5384e03d9f40609d3afbbf0d44cbb0" }, "purchase_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "cost_price": "11.0", "sales_prices": [ { "id": "86ad9d5e93b14d17868bd5d0dca2ced7", "displayed_as": "Sales Price", "created_at": "2022-12-30T14:22:52Z", "updated_at": "2022-12-30T14:22:52Z", "price_name": "Sales Price", "price": "17.0", "price_includes_tax": false, "product_sales_price_type": { "id": "26024c3e7357462897edb896cc7084e9", "displayed_as": "Sales Price", "$path": "/product_sales_price_types/26024c3e7357462897edb896cc7084e9" } }, { "id": "475155baea544af9ab70975db3fc360d", "displayed_as": "Trade", "created_at": "2022-12-30T14:22:52Z", "updated_at": "2022-12-30T14:22:52Z", "price_name": "Trade", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "1d0fee218bcc425f803dc1bca63c3666", "displayed_as": "Trade", "$path": "/product_sales_price_types/1d0fee218bcc425f803dc1bca63c3666" } }, { "id": "2581fb3a4261444d89446b1285b8597d", "displayed_as": "Wholesale", "created_at": "2022-12-30T14:22:52Z", "updated_at": "2022-12-30T14:22:52Z", "price_name": "Wholesale", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "2c424fdefbe944aaa69cd1ce0c7277a3", "displayed_as": "Wholesale", "$path": "/product_sales_price_types/2c424fdefbe944aaa69cd1ce0c7277a3" } } ], "source_guid": null, "purchase_description": null, "active": true, "catalog_item_type": { "id": "PRODUCT", "displayed_as": "Non-stock", "$path": "/catalog_item_types/PRODUCT" } } } } } } } }, "tags": [ "Products" ], "operationId": "getProductsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/products/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Product", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Product Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putProducts" }, "examples": { "Request example": { "value": { "product": { "description": "string", "sales_ledger_account_id": "string", "purchase_ledger_account_id": "string", "item_code": "string", "notes": "string", "sales_tax_rate_id": "string", "usual_supplier_id": "string", "purchase_tax_rate_id": "string", "cost_price": 0.1, "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type_id": "string", "sales_prices": [ { "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Product", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "active": true, "catalog_item_type": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Products" ], "operationId": "putProductsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/products/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"product\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"active\":true,\"catalog_item_type_id\":\"string\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"product\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"active\":true,\"catalog_item_type_id\":\"string\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/products/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"product\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"active\":true,\"catalog_item_type_id\":\"string\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/products/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"product\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"active\": true,\n \"catalog_item_type_id\": \"string\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": true,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/products/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n product: {\n description: 'string',\n sales_ledger_account_id: 'string',\n purchase_ledger_account_id: 'string',\n item_code: 'string',\n notes: 'string',\n sales_tax_rate_id: 'string',\n usual_supplier_id: 'string',\n purchase_tax_rate_id: 'string',\n cost_price: 0.1,\n source_guid: 'string',\n purchase_description: 'string',\n active: true,\n catalog_item_type_id: 'string',\n sales_prices: [\n {\n price_name: 'string',\n price: 0.1,\n price_includes_tax: true,\n product_sales_price_type_id: 'string'\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"product\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"active\\\":true,\\\"catalog_item_type_id\\\":\\\"string\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/products/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\"\n\npayload = {\"product\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"active\": True,\n \"catalog_item_type_id\": \"string\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": True,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Product", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Product Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Product" } }, "tags": [ "Products" ], "operationId": "deleteProductsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/products/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/products/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/products/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/products/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/products/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/products/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/services": { "get": { "summary": "Returns all Services", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "search", "description": "Use this to filter by the item code or description.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Services changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Services 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "active", "description": "Use this to only return active or inactive items", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Services per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Services", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Services (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Services", "content": { "application/json": { "examples": { "response": { "value": { "$total": 2, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "2c7c2b660e38470bb160c80eeb1e0fad", "displayed_as": "Test service", "$path": "/services/2c7c2b660e38470bb160c80eeb1e0fad" }, { "id": "9019ad6d8341424ba81296df4b0ea45f", "displayed_as": "Free Text", "$path": "/services/9019ad6d8341424ba81296df4b0ea45f" } ] } } } } } } }, "tags": [ "Services" ], "operationId": "getServices", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/services?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/services\"\n\nquerystring = {\"search\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"active\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Service", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postServices" }, "examples": { "Request example": { "value": { "service": { "description": "string", "sales_ledger_account_id": "string", "item_code": "string", "notes": "string", "purchase_ledger_account_id": "string", "sales_tax_rate_id": "string", "purchase_tax_rate_id": "string", "source_guid": "string", "purchase_description": "string", "usual_supplier_id": "string", "active": true, "cost_price": 0.1, "oss_service": true, "sales_rates": [ { "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true } } } } } } }, "tags": [ "Services" ], "operationId": "postServices", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/services \\\n --header 'Content-Type: application/json' \\\n --data '{\"service\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"purchase_ledger_account_id\":\"string\",\"sales_tax_rate_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"source_guid\":\"string\",\"purchase_description\":\"string\",\"usual_supplier_id\":\"string\",\"active\":true,\"cost_price\":0.1,\"oss_service\":true,\"sales_rates\":[{\"rate_name\":\"string\",\"rate\":0.1,\"rate_includes_tax\":true,\"service_rate_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"service\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"purchase_ledger_account_id\":\"string\",\"sales_tax_rate_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"source_guid\":\"string\",\"purchase_description\":\"string\",\"usual_supplier_id\":\"string\",\"active\":true,\"cost_price\":0.1,\"oss_service\":true,\"sales_rates\":[{\"rate_name\":\"string\",\"rate\":0.1,\"rate_includes_tax\":true,\"service_rate_type_id\":\"string\"}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/services \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"service\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"purchase_ledger_account_id\":\"string\",\"sales_tax_rate_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"source_guid\":\"string\",\"purchase_description\":\"string\",\"usual_supplier_id\":\"string\",\"active\":true,\"cost_price\":0.1,\"oss_service\":true,\"sales_rates\":[{\"rate_name\":\"string\",\"rate\":0.1,\"rate_includes_tax\":true,\"service_rate_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/services", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"service\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"active\": true,\n \"cost_price\": 0.1,\n \"oss_service\": true,\n \"sales_rates\": [\n {\n \"rate_name\": \"string\",\n \"rate\": 0.1,\n \"rate_includes_tax\": true,\n \"service_rate_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/services\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/services\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/services\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n service: {\n description: 'string',\n sales_ledger_account_id: 'string',\n item_code: 'string',\n notes: 'string',\n purchase_ledger_account_id: 'string',\n sales_tax_rate_id: 'string',\n purchase_tax_rate_id: 'string',\n source_guid: 'string',\n purchase_description: 'string',\n usual_supplier_id: 'string',\n active: true,\n cost_price: 0.1,\n oss_service: true,\n sales_rates: [\n {\n rate_name: 'string',\n rate: 0.1,\n rate_includes_tax: true,\n service_rate_type_id: 'string'\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/services\"),\n Content = new StringContent(\"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/services\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/services\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/services\"\n\npayload = {\"service\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"active\": True,\n \"cost_price\": 0.1,\n \"oss_service\": True,\n \"sales_rates\": [\n {\n \"rate_name\": \"string\",\n \"rate\": 0.1,\n \"rate_includes_tax\": True,\n \"service_rate_type_id\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/services/{key}": { "get": { "summary": "Returns a Service", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Service Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Service (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Service", "content": { "application/json": { "examples": { "response": { "value": { "id": "2c7c2b660e38470bb160c80eeb1e0fad", "displayed_as": "Test service", "$path": "/services/2c7c2b660e38470bb160c80eeb1e0fad", "created_at": "2023-01-16T12:26:40Z", "updated_at": "2023-01-16T12:26:40Z", "links": [ { "href": "https://accounts-extra.sageone.com/advanced_uk/products_services/15716499", "rel": "alternate", "type": "text/html" } ], "deletable": false, "deactivatable": true, "used_on_recurring_invoice": false, "item_code": "SER001", "description": "Test service", "notes": "", "sales_ledger_account": { "id": "7a639255884911ed84fa0252b90cda0d", "displayed_as": "Sales - Services (4010)", "$path": "/ledger_accounts/7a639255884911ed84fa0252b90cda0d" }, "purchase_ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "sales_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "purchase_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "sales_rates": [ { "id": "112003bd9c974dc2b62b7bcef03b28df", "displayed_as": "Rate", "created_at": "2023-01-16T12:26:40Z", "updated_at": "2023-01-16T12:26:40Z", "rate_name": "Rate", "rate": "1002.0", "rate_includes_tax": false, "service_rate_type": { "id": "923df5f576dc46559977f7997e14b08f", "displayed_as": "Rate", "$path": "/service_rate_types/923df5f576dc46559977f7997e14b08f" } } ], "source_guid": null, "purchase_description": "", "usual_supplier": null, "active": true, "cost_price": "0.0", "oss_service": false } } } } } } }, "tags": [ "Services" ], "operationId": "getServicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/services/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Service", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Service Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putServices" }, "examples": { "Request example": { "value": { "service": { "description": "string", "sales_ledger_account_id": "string", "item_code": "string", "notes": "string", "purchase_ledger_account_id": "string", "sales_tax_rate_id": "string", "purchase_tax_rate_id": "string", "source_guid": "string", "purchase_description": "string", "usual_supplier_id": "string", "active": true, "cost_price": 0.1, "oss_service": true, "sales_rates": [ { "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_rates": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "rate_name": "string", "rate": 0.1, "rate_includes_tax": true, "service_rate_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "active": true, "cost_price": 0.1, "oss_service": true } } } } } } }, "tags": [ "Services" ], "operationId": "putServicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/services/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"service\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"purchase_ledger_account_id\":\"string\",\"sales_tax_rate_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"source_guid\":\"string\",\"purchase_description\":\"string\",\"usual_supplier_id\":\"string\",\"active\":true,\"cost_price\":0.1,\"oss_service\":true,\"sales_rates\":[{\"rate_name\":\"string\",\"rate\":0.1,\"rate_includes_tax\":true,\"service_rate_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"service\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"purchase_ledger_account_id\":\"string\",\"sales_tax_rate_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"source_guid\":\"string\",\"purchase_description\":\"string\",\"usual_supplier_id\":\"string\",\"active\":true,\"cost_price\":0.1,\"oss_service\":true,\"sales_rates\":[{\"rate_name\":\"string\",\"rate\":0.1,\"rate_includes_tax\":true,\"service_rate_type_id\":\"string\"}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/services/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"service\":{\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"item_code\":\"string\",\"notes\":\"string\",\"purchase_ledger_account_id\":\"string\",\"sales_tax_rate_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"source_guid\":\"string\",\"purchase_description\":\"string\",\"usual_supplier_id\":\"string\",\"active\":true,\"cost_price\":0.1,\"oss_service\":true,\"sales_rates\":[{\"rate_name\":\"string\",\"rate\":0.1,\"rate_includes_tax\":true,\"service_rate_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/services/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"service\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"active\": true,\n \"cost_price\": 0.1,\n \"oss_service\": true,\n \"sales_rates\": [\n {\n \"rate_name\": \"string\",\n \"rate\": 0.1,\n \"rate_includes_tax\": true,\n \"service_rate_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/services/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n service: {\n description: 'string',\n sales_ledger_account_id: 'string',\n item_code: 'string',\n notes: 'string',\n purchase_ledger_account_id: 'string',\n sales_tax_rate_id: 'string',\n purchase_tax_rate_id: 'string',\n source_guid: 'string',\n purchase_description: 'string',\n usual_supplier_id: 'string',\n active: true,\n cost_price: 0.1,\n oss_service: true,\n sales_rates: [\n {\n rate_name: 'string',\n rate: 0.1,\n rate_includes_tax: true,\n service_rate_type_id: 'string'\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"service\\\":{\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"item_code\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"active\\\":true,\\\"cost_price\\\":0.1,\\\"oss_service\\\":true,\\\"sales_rates\\\":[{\\\"rate_name\\\":\\\"string\\\",\\\"rate\\\":0.1,\\\"rate_includes_tax\\\":true,\\\"service_rate_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/services/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\"\n\npayload = {\"service\": {\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"item_code\": \"string\",\n \"notes\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"active\": True,\n \"cost_price\": 0.1,\n \"oss_service\": True,\n \"sales_rates\": [\n {\n \"rate_name\": \"string\",\n \"rate\": 0.1,\n \"rate_includes_tax\": True,\n \"service_rate_type_id\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Service", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Service Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Service" } }, "tags": [ "Services" ], "operationId": "deleteServicesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/services/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/services/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/services/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/services/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/services/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/services/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/service_rate_types": { "get": { "summary": "Returns all Service Rate Types", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Service Rates changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "active", "description": "Use this to only return active or inactive items", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Service Rates per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Service Rates", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Service Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Service Rate Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 1, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "923df5f576dc46559977f7997e14b08f", "displayed_as": "Rate", "$path": "/service_rate_types/923df5f576dc46559977f7997e14b08f" } ] } } } } } } }, "tags": [ "Service Rate Types" ], "operationId": "getServiceRateTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/service_rate_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/service_rate_types\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"active\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Service Rate Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postServiceRateTypes" }, "examples": { "Request example": { "value": { "service_rate_type": { "name": "string", "active": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Service Rate Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRateType" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "active": true } } } } } } }, "tags": [ "Service Rate Types" ], "operationId": "postServiceRateTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/service_rate_types \\\n --header 'Content-Type: application/json' \\\n --data '{\"service_rate_type\":{\"name\":\"string\",\"active\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"service_rate_type\":{\"name\":\"string\",\"active\":true}}' | \\\n http POST https://api.accounting.sage.com/v3.1/service_rate_types \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"service_rate_type\":{\"name\":\"string\",\"active\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/service_rate_types", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"service_rate_type\": {\n \"name\": \"string\",\n \"active\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/service_rate_types\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/service_rate_types\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/service_rate_types\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({service_rate_type: {name: 'string', active: true}}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/service_rate_types\"),\n Content = new StringContent(\"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/service_rate_types\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/service_rate_types\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/service_rate_types\"\n\npayload = {\"service_rate_type\": {\n \"name\": \"string\",\n \"active\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/service_rate_types/{key}": { "get": { "summary": "Returns a Service Rate Type", "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 mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Service Rate Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Service Rate (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Service Rate Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "923df5f576dc46559977f7997e14b08f", "displayed_as": "Rate", "$path": "/service_rate_types/923df5f576dc46559977f7997e14b08f", "created_at": "2022-12-30T13:54:28Z", "updated_at": "2022-12-30T13:54:28Z", "name": "Rate", "active": true } } } } } } }, "tags": [ "Service Rate Types" ], "operationId": "getServiceRateTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/service_rate_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Service Rate Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Service Rate Type Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putServiceRateTypes" }, "examples": { "Request example": { "value": { "service_rate_type": { "name": "string", "active": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Service Rate Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRateType" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "active": true } } } } } } }, "tags": [ "Service Rate Types" ], "operationId": "putServiceRateTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"service_rate_type\":{\"name\":\"string\",\"active\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"service_rate_type\":{\"name\":\"string\",\"active\":true}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"service_rate_type\":{\"name\":\"string\",\"active\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"service_rate_type\": {\n \"name\": \"string\",\n \"active\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/service_rate_types/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({service_rate_type: {name: 'string', active: true}}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"service_rate_type\\\":{\\\"name\\\":\\\"string\\\",\\\"active\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/service_rate_types/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\"\n\npayload = {\"service_rate_type\": {\n \"name\": \"string\",\n \"active\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Service Rate Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Service Rate Type Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Service Rate Type" } }, "tags": [ "Service Rate Types" ], "operationId": "deleteServiceRateTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/service_rate_types/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/service_rate_types/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/service_rate_types/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/stock_items": { "get": { "summary": "Returns all Stock Items", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "search", "description": "Use this to filter by the item code or description.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Stock Items 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "deleted_since", "description": "Use this to limit the response to Stock Items 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "active", "description": "Use this to only return active or inactive items", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "out_of_stock", "description": "Use this to filter by the Stock Items that are out of stock", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "below_reorder_level", "description": "Use this to filter by the Stock Items that are below the reorder level", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Stock Items per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Stock Items", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Stock Items (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Stock Items", "content": { "application/json": { "examples": { "response": { "value": { "$total": 3, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "08d49f8a63d54c73b42490e2a3c8f454", "displayed_as": "test stock product", "$path": "/stock_items/08d49f8a63d54c73b42490e2a3c8f454" }, { "id": "568191f2d6b240a3b9cf672e6ebf6a21", "displayed_as": "glasses", "$path": "/stock_items/568191f2d6b240a3b9cf672e6ebf6a21" }, { "id": "788b755081ee474fa7bf044c559e9957", "displayed_as": "1", "$path": "/stock_items/788b755081ee474fa7bf044c559e9957" } ] } } } } } } }, "tags": [ "Stock Items" ], "operationId": "getStockItems", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/stock_items?search=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&deleted_since=2015-10-27T16%3A24%3A52Z&active=SOME_BOOLEAN_VALUE&out_of_stock=SOME_BOOLEAN_VALUE&below_reorder_level=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_items\"\n\nquerystring = {\"search\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"deleted_since\":\"2015-10-27T16:24:52Z\",\"active\":\"SOME_BOOLEAN_VALUE\",\"out_of_stock\":\"SOME_BOOLEAN_VALUE\",\"below_reorder_level\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Stock Item", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postStockItems" }, "examples": { "Request example": { "value": { "stock_item": { "item_code": "string", "description": "string", "sales_ledger_account_id": "string", "purchase_ledger_account_id": "string", "notes": "string", "sales_tax_rate_id": "string", "usual_supplier_id": "string", "purchase_tax_rate_id": "string", "cost_price": 0.1, "source_guid": "string", "purchase_description": "string", "reorder_level": 0.1, "reorder_quantity": 0.1, "location": "string", "barcode": "string", "supplier_part_number": "string", "weight": 0.1, "measurement_unit": "string", "weight_converted": 0.1, "active": true, "quantity_in_stock": 0.1, "last_cost_price": 0.1, "last_cost_price_stock_value": 0.1, "average_cost_price": 0.1, "average_cost_price_stock_value": 0.1, "cost_price_last_updated": "2019-08-24", "sales_prices": [ { "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Stock Item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItem" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "reorder_level": 0.1, "reorder_quantity": 0.1, "location": "string", "barcode": "string", "supplier_part_number": "string", "weight": 0.1, "measurement_unit": "string", "weight_converted": 0.1, "active": true, "quantity_in_stock": 0.1, "last_cost_price": 0.1, "last_cost_price_stock_value": 0.1, "average_cost_price": 0.1, "average_cost_price_stock_value": 0.1, "cost_price_last_updated": "2019-08-24" } } } } } } }, "tags": [ "Stock Items" ], "operationId": "postStockItems", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/stock_items \\\n --header 'Content-Type: application/json' \\\n --data '{\"stock_item\":{\"item_code\":\"string\",\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"reorder_level\":0.1,\"reorder_quantity\":0.1,\"location\":\"string\",\"barcode\":\"string\",\"supplier_part_number\":\"string\",\"weight\":0.1,\"measurement_unit\":\"string\",\"weight_converted\":0.1,\"active\":true,\"quantity_in_stock\":0.1,\"last_cost_price\":0.1,\"last_cost_price_stock_value\":0.1,\"average_cost_price\":0.1,\"average_cost_price_stock_value\":0.1,\"cost_price_last_updated\":\"2019-08-24\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"stock_item\":{\"item_code\":\"string\",\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"reorder_level\":0.1,\"reorder_quantity\":0.1,\"location\":\"string\",\"barcode\":\"string\",\"supplier_part_number\":\"string\",\"weight\":0.1,\"measurement_unit\":\"string\",\"weight_converted\":0.1,\"active\":true,\"quantity_in_stock\":0.1,\"last_cost_price\":0.1,\"last_cost_price_stock_value\":0.1,\"average_cost_price\":0.1,\"average_cost_price_stock_value\":0.1,\"cost_price_last_updated\":\"2019-08-24\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/stock_items \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"stock_item\":{\"item_code\":\"string\",\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"reorder_level\":0.1,\"reorder_quantity\":0.1,\"location\":\"string\",\"barcode\":\"string\",\"supplier_part_number\":\"string\",\"weight\":0.1,\"measurement_unit\":\"string\",\"weight_converted\":0.1,\"active\":true,\"quantity_in_stock\":0.1,\"last_cost_price\":0.1,\"last_cost_price_stock_value\":0.1,\"average_cost_price\":0.1,\"average_cost_price_stock_value\":0.1,\"cost_price_last_updated\":\"2019-08-24\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/stock_items", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"stock_item\": {\n \"item_code\": \"string\",\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"reorder_level\": 0.1,\n \"reorder_quantity\": 0.1,\n \"location\": \"string\",\n \"barcode\": \"string\",\n \"supplier_part_number\": \"string\",\n \"weight\": 0.1,\n \"measurement_unit\": \"string\",\n \"weight_converted\": 0.1,\n \"active\": true,\n \"quantity_in_stock\": 0.1,\n \"last_cost_price\": 0.1,\n \"last_cost_price_stock_value\": 0.1,\n \"average_cost_price\": 0.1,\n \"average_cost_price_stock_value\": 0.1,\n \"cost_price_last_updated\": \"2019-08-24\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": true,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/stock_items\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_items\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_items\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n stock_item: {\n item_code: 'string',\n description: 'string',\n sales_ledger_account_id: 'string',\n purchase_ledger_account_id: 'string',\n notes: 'string',\n sales_tax_rate_id: 'string',\n usual_supplier_id: 'string',\n purchase_tax_rate_id: 'string',\n cost_price: 0.1,\n source_guid: 'string',\n purchase_description: 'string',\n reorder_level: 0.1,\n reorder_quantity: 0.1,\n location: 'string',\n barcode: 'string',\n supplier_part_number: 'string',\n weight: 0.1,\n measurement_unit: 'string',\n weight_converted: 0.1,\n active: true,\n quantity_in_stock: 0.1,\n last_cost_price: 0.1,\n last_cost_price_stock_value: 0.1,\n average_cost_price: 0.1,\n average_cost_price_stock_value: 0.1,\n cost_price_last_updated: '2019-08-24',\n sales_prices: [\n {\n price_name: 'string',\n price: 0.1,\n price_includes_tax: true,\n product_sales_price_type_id: 'string'\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_items\"),\n Content = new StringContent(\"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_items\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/stock_items\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_items\"\n\npayload = {\"stock_item\": {\n \"item_code\": \"string\",\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"reorder_level\": 0.1,\n \"reorder_quantity\": 0.1,\n \"location\": \"string\",\n \"barcode\": \"string\",\n \"supplier_part_number\": \"string\",\n \"weight\": 0.1,\n \"measurement_unit\": \"string\",\n \"weight_converted\": 0.1,\n \"active\": True,\n \"quantity_in_stock\": 0.1,\n \"last_cost_price\": 0.1,\n \"last_cost_price_stock_value\": 0.1,\n \"average_cost_price\": 0.1,\n \"average_cost_price_stock_value\": 0.1,\n \"cost_price_last_updated\": \"2019-08-24\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": True,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/stock_items/{key}": { "get": { "summary": "Returns a Stock Item", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Stock Item Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Stock Item (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Stock Item", "content": { "application/json": { "examples": { "response": { "value": { "id": "568191f2d6b240a3b9cf672e6ebf6a21", "displayed_as": "glasses", "$path": "/stock_items/568191f2d6b240a3b9cf672e6ebf6a21", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-13T08:04:15Z", "links": [ { "href": "https://accounts-extra.sageone.com/advanced_uk/products_services/18209136", "rel": "alternate", "type": "text/html" } ], "deletable": false, "deactivatable": true, "used_on_recurring_invoice": false, "item_code": "glasses", "description": "glasses", "notes": "", "sales_ledger_account": { "id": "7a5e37b4884911ed84fa0252b90cda0d", "displayed_as": "Sales - Products (4000)", "$path": "/ledger_accounts/7a5e37b4884911ed84fa0252b90cda0d" }, "sales_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "purchase_ledger_account": { "id": "7a5ab138884911ed84fa0252b90cda0d", "displayed_as": "Stock - Raw Materials (1000)", "$path": "/ledger_accounts/7a5ab138884911ed84fa0252b90cda0d" }, "usual_supplier": { "id": "975c76ff2d3b4cd6b8d0faf37004ca73", "displayed_as": "McNally Computer Supplies (MCN001)", "$path": "/usual_suppliers/975c76ff2d3b4cd6b8d0faf37004ca73" }, "purchase_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "cost_price": "10.0", "sales_prices": [ { "id": "1e5e182c1ffb4bfe9bf6715fb9a2951c", "displayed_as": "Sales Price", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-03T09:59:42Z", "price_name": "Sales Price", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "26024c3e7357462897edb896cc7084e9", "displayed_as": "Sales Price", "$path": "/product_sales_price_types/26024c3e7357462897edb896cc7084e9" } }, { "id": "63f3d2d4e3a2454fbb54ca92b05c9122", "displayed_as": "Trade", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-03T09:59:42Z", "price_name": "Trade", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "1d0fee218bcc425f803dc1bca63c3666", "displayed_as": "Trade", "$path": "/product_sales_price_types/1d0fee218bcc425f803dc1bca63c3666" } }, { "id": "b76b365b2aca4a00832371d5c7264728", "displayed_as": "Wholesale", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-03T09:59:42Z", "price_name": "Wholesale", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "2c424fdefbe944aaa69cd1ce0c7277a3", "displayed_as": "Wholesale", "$path": "/product_sales_price_types/2c424fdefbe944aaa69cd1ce0c7277a3" } } ], "source_guid": null, "purchase_description": "", "reorder_level": "0.0", "reorder_quantity": "0.0", "location": "", "barcode": "", "supplier_part_number": "", "weight": 0, "measurement_unit": "kg", "weight_converted": "0.0", "active": true, "quantity_in_stock": "0.0", "last_cost_price": "5.0", "last_cost_price_stock_value": "0.0", "average_cost_price": "8.33", "average_cost_price_stock_value": "0.0", "cost_price_last_updated": "2024-05-13T08:02:03.000Z" } } } } } } }, "tags": [ "Stock Items" ], "operationId": "getStockItemsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/stock_items/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Stock Item", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Stock Item Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putStockItems" }, "examples": { "Request example": { "value": { "stock_item": { "item_code": "string", "description": "string", "sales_ledger_account_id": "string", "purchase_ledger_account_id": "string", "notes": "string", "sales_tax_rate_id": "string", "usual_supplier_id": "string", "purchase_tax_rate_id": "string", "cost_price": 0.1, "source_guid": "string", "purchase_description": "string", "reorder_level": 0.1, "reorder_quantity": 0.1, "location": "string", "barcode": "string", "supplier_part_number": "string", "weight": 0.1, "measurement_unit": "string", "weight_converted": 0.1, "active": true, "quantity_in_stock": 0.1, "last_cost_price": 0.1, "last_cost_price_stock_value": 0.1, "average_cost_price": 0.1, "average_cost_price_stock_value": 0.1, "cost_price_last_updated": "2019-08-24", "sales_prices": [ { "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Stock Item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItem" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "reorder_level": 0.1, "reorder_quantity": 0.1, "location": "string", "barcode": "string", "supplier_part_number": "string", "weight": 0.1, "measurement_unit": "string", "weight_converted": 0.1, "active": true, "quantity_in_stock": 0.1, "last_cost_price": 0.1, "last_cost_price_stock_value": 0.1, "average_cost_price": 0.1, "average_cost_price_stock_value": 0.1, "cost_price_last_updated": "2019-08-24" } } } } } } }, "tags": [ "Stock Items" ], "operationId": "putStockItemsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"stock_item\":{\"item_code\":\"string\",\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"reorder_level\":0.1,\"reorder_quantity\":0.1,\"location\":\"string\",\"barcode\":\"string\",\"supplier_part_number\":\"string\",\"weight\":0.1,\"measurement_unit\":\"string\",\"weight_converted\":0.1,\"active\":true,\"quantity_in_stock\":0.1,\"last_cost_price\":0.1,\"last_cost_price_stock_value\":0.1,\"average_cost_price\":0.1,\"average_cost_price_stock_value\":0.1,\"cost_price_last_updated\":\"2019-08-24\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"stock_item\":{\"item_code\":\"string\",\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"reorder_level\":0.1,\"reorder_quantity\":0.1,\"location\":\"string\",\"barcode\":\"string\",\"supplier_part_number\":\"string\",\"weight\":0.1,\"measurement_unit\":\"string\",\"weight_converted\":0.1,\"active\":true,\"quantity_in_stock\":0.1,\"last_cost_price\":0.1,\"last_cost_price_stock_value\":0.1,\"average_cost_price\":0.1,\"average_cost_price_stock_value\":0.1,\"cost_price_last_updated\":\"2019-08-24\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"stock_item\":{\"item_code\":\"string\",\"description\":\"string\",\"sales_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"notes\":\"string\",\"sales_tax_rate_id\":\"string\",\"usual_supplier_id\":\"string\",\"purchase_tax_rate_id\":\"string\",\"cost_price\":0.1,\"source_guid\":\"string\",\"purchase_description\":\"string\",\"reorder_level\":0.1,\"reorder_quantity\":0.1,\"location\":\"string\",\"barcode\":\"string\",\"supplier_part_number\":\"string\",\"weight\":0.1,\"measurement_unit\":\"string\",\"weight_converted\":0.1,\"active\":true,\"quantity_in_stock\":0.1,\"last_cost_price\":0.1,\"last_cost_price_stock_value\":0.1,\"average_cost_price\":0.1,\"average_cost_price_stock_value\":0.1,\"cost_price_last_updated\":\"2019-08-24\",\"sales_prices\":[{\"price_name\":\"string\",\"price\":0.1,\"price_includes_tax\":true,\"product_sales_price_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"stock_item\": {\n \"item_code\": \"string\",\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"reorder_level\": 0.1,\n \"reorder_quantity\": 0.1,\n \"location\": \"string\",\n \"barcode\": \"string\",\n \"supplier_part_number\": \"string\",\n \"weight\": 0.1,\n \"measurement_unit\": \"string\",\n \"weight_converted\": 0.1,\n \"active\": true,\n \"quantity_in_stock\": 0.1,\n \"last_cost_price\": 0.1,\n \"last_cost_price_stock_value\": 0.1,\n \"average_cost_price\": 0.1,\n \"average_cost_price_stock_value\": 0.1,\n \"cost_price_last_updated\": \"2019-08-24\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": true,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_items/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n stock_item: {\n item_code: 'string',\n description: 'string',\n sales_ledger_account_id: 'string',\n purchase_ledger_account_id: 'string',\n notes: 'string',\n sales_tax_rate_id: 'string',\n usual_supplier_id: 'string',\n purchase_tax_rate_id: 'string',\n cost_price: 0.1,\n source_guid: 'string',\n purchase_description: 'string',\n reorder_level: 0.1,\n reorder_quantity: 0.1,\n location: 'string',\n barcode: 'string',\n supplier_part_number: 'string',\n weight: 0.1,\n measurement_unit: 'string',\n weight_converted: 0.1,\n active: true,\n quantity_in_stock: 0.1,\n last_cost_price: 0.1,\n last_cost_price_stock_value: 0.1,\n average_cost_price: 0.1,\n average_cost_price_stock_value: 0.1,\n cost_price_last_updated: '2019-08-24',\n sales_prices: [\n {\n price_name: 'string',\n price: 0.1,\n price_includes_tax: true,\n product_sales_price_type_id: 'string'\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"stock_item\\\":{\\\"item_code\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\",\\\"sales_tax_rate_id\\\":\\\"string\\\",\\\"usual_supplier_id\\\":\\\"string\\\",\\\"purchase_tax_rate_id\\\":\\\"string\\\",\\\"cost_price\\\":0.1,\\\"source_guid\\\":\\\"string\\\",\\\"purchase_description\\\":\\\"string\\\",\\\"reorder_level\\\":0.1,\\\"reorder_quantity\\\":0.1,\\\"location\\\":\\\"string\\\",\\\"barcode\\\":\\\"string\\\",\\\"supplier_part_number\\\":\\\"string\\\",\\\"weight\\\":0.1,\\\"measurement_unit\\\":\\\"string\\\",\\\"weight_converted\\\":0.1,\\\"active\\\":true,\\\"quantity_in_stock\\\":0.1,\\\"last_cost_price\\\":0.1,\\\"last_cost_price_stock_value\\\":0.1,\\\"average_cost_price\\\":0.1,\\\"average_cost_price_stock_value\\\":0.1,\\\"cost_price_last_updated\\\":\\\"2019-08-24\\\",\\\"sales_prices\\\":[{\\\"price_name\\\":\\\"string\\\",\\\"price\\\":0.1,\\\"price_includes_tax\\\":true,\\\"product_sales_price_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/stock_items/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\"\n\npayload = {\"stock_item\": {\n \"item_code\": \"string\",\n \"description\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"notes\": \"string\",\n \"sales_tax_rate_id\": \"string\",\n \"usual_supplier_id\": \"string\",\n \"purchase_tax_rate_id\": \"string\",\n \"cost_price\": 0.1,\n \"source_guid\": \"string\",\n \"purchase_description\": \"string\",\n \"reorder_level\": 0.1,\n \"reorder_quantity\": 0.1,\n \"location\": \"string\",\n \"barcode\": \"string\",\n \"supplier_part_number\": \"string\",\n \"weight\": 0.1,\n \"measurement_unit\": \"string\",\n \"weight_converted\": 0.1,\n \"active\": True,\n \"quantity_in_stock\": 0.1,\n \"last_cost_price\": 0.1,\n \"last_cost_price_stock_value\": 0.1,\n \"average_cost_price\": 0.1,\n \"average_cost_price_stock_value\": 0.1,\n \"cost_price_last_updated\": \"2019-08-24\",\n \"sales_prices\": [\n {\n \"price_name\": \"string\",\n \"price\": 0.1,\n \"price_includes_tax\": True,\n \"product_sales_price_type_id\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Stock Item", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Stock Item Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Stock Item" } }, "tags": [ "Stock Items" ], "operationId": "deleteStockItemsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_items/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/stock_items/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_items/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/stock_movements": { "get": { "summary": "Returns all Stock Movements", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "search", "description": "Use this to filter by the details", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "stock_item_id", "description": "Use this to filter by stock_item_id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "from_date", "description": "Use this to filter by Stock Movements dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "to_date", "description": "Use this to filter by Stock Movements dates", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Stock Movements per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Stock Movements", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Stock Movements (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Stock Movements", "content": { "application/json": { "examples": { "response": { "value": { "$total": 10, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "9d8236e736aa4e57990a1554525295c8", "displayed_as": "Opening Balance", "$path": "/stock_movements/9d8236e736aa4e57990a1554525295c8" }, { "id": "f786042df3d7434d8c4d4de2d3739327", "displayed_as": "Compton Packaging (Ref: SI-252)", "$path": "/stock_movements/f786042df3d7434d8c4d4de2d3739327" }, { "id": "75a320e0561e4b6999fb084a0acda641", "displayed_as": "Compton Packaging (Ref: SI-253)", "$path": "/stock_movements/75a320e0561e4b6999fb084a0acda641" }, { "id": "345fd8762d4e4a13b3029e8a2238b9a2", "displayed_as": "Compton Packaging (Ref: SCN-28)", "$path": "/stock_movements/345fd8762d4e4a13b3029e8a2238b9a2" }, { "id": "7d1c801683f946d78d22ebde46ae8031", "displayed_as": "Stock take adjustment", "$path": "/stock_movements/7d1c801683f946d78d22ebde46ae8031" }, { "id": "dd6069e53f114a4584b29bbb33cd9666", "displayed_as": "Windsor (Ref: SCN-47)", "$path": "/stock_movements/dd6069e53f114a4584b29bbb33cd9666" }, { "id": "3d9d82e51ed44046991a4ed0f863bafa", "displayed_as": "Opening Balance", "$path": "/stock_movements/3d9d82e51ed44046991a4ed0f863bafa" }, { "id": "af7458c2ca1d4722b0d7384c02b994c1", "displayed_as": "Stock take adjustment", "$path": "/stock_movements/af7458c2ca1d4722b0d7384c02b994c1" }, { "id": "ab298f9c429d44b09510da84620543c0", "displayed_as": "Stock take adjustment", "$path": "/stock_movements/ab298f9c429d44b09510da84620543c0" }, { "id": "db7d38a5bf7246eeb7f7ff89b313b0e0", "displayed_as": "ABS Garages Ltd (Ref: SI-367)", "$path": "/stock_movements/db7d38a5bf7246eeb7f7ff89b313b0e0" } ] } } } } } } }, "tags": [ "Stock Movements" ], "operationId": "getStockMovements", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/stock_movements?search=SOME_STRING_VALUE&stock_item_id=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_movements\"\n\nquerystring = {\"search\":\"SOME_STRING_VALUE\",\"stock_item_id\":\"SOME_STRING_VALUE\",\"from_date\":\"SOME_STRING_VALUE\",\"to_date\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Stock Movement", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postStockMovements" }, "examples": { "Request example": { "value": { "stock_movement": { "stock_item_id": "string", "date": "2019-08-24", "quantity": 0.1, "cost_price": 0.1, "details": "string", "movement_number": "string", "reference": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Stock Movement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockMovement" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "movement_number": "stri", "date": "2019-08-24", "cost_price": 0.1, "quantity": 0.1, "details": "string", "reference": "string", "stock_item": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "reorder_level": 0.1, "reorder_quantity": 0.1, "location": "string", "barcode": "string", "supplier_part_number": "string", "weight": 0.1, "measurement_unit": "string", "weight_converted": 0.1, "active": true, "quantity_in_stock": 0.1, "last_cost_price": 0.1, "last_cost_price_stock_value": 0.1, "average_cost_price": 0.1, "average_cost_price_stock_value": 0.1, "cost_price_last_updated": "2019-08-24" } } } } } } } }, "tags": [ "Stock Movements" ], "operationId": "postStockMovements", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/stock_movements \\\n --header 'Content-Type: application/json' \\\n --data '{\"stock_movement\":{\"stock_item_id\":\"string\",\"date\":\"2019-08-24\",\"quantity\":0.1,\"cost_price\":0.1,\"details\":\"string\",\"movement_number\":\"string\",\"reference\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"stock_movement\":{\"stock_item_id\":\"string\",\"date\":\"2019-08-24\",\"quantity\":0.1,\"cost_price\":0.1,\"details\":\"string\",\"movement_number\":\"string\",\"reference\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/stock_movements \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"stock_movement\":{\"stock_item_id\":\"string\",\"date\":\"2019-08-24\",\"quantity\":0.1,\"cost_price\":0.1,\"details\":\"string\",\"movement_number\":\"string\",\"reference\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/stock_movements", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"stock_movement\": {\n \"stock_item_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"quantity\": 0.1,\n \"cost_price\": 0.1,\n \"details\": \"string\",\n \"movement_number\": \"string\",\n \"reference\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/stock_movements\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_movements\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_movements\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n stock_movement: {\n stock_item_id: 'string',\n date: '2019-08-24',\n quantity: 0.1,\n cost_price: 0.1,\n details: 'string',\n movement_number: 'string',\n reference: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_movements\"),\n Content = new StringContent(\"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_movements\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/stock_movements\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_movements\"\n\npayload = {\"stock_movement\": {\n \"stock_item_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"quantity\": 0.1,\n \"cost_price\": 0.1,\n \"details\": \"string\",\n \"movement_number\": \"string\",\n \"reference\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/stock_movements/{key}": { "get": { "summary": "Returns a Stock Movement", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Read Only, Restricted Access, Full Access\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Stock Movement Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Stock Movement (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Stock Movement", "content": { "application/json": { "examples": { "response": { "value": { "id": "af7458c2ca1d4722b0d7384c02b994c1", "displayed_as": "Stock take adjustment", "$path": "/stock_movements/af7458c2ca1d4722b0d7384c02b994c1", "links": [ { "href": null, "rel": "alternate", "type": "text/html" } ], "created_at": "2024-05-13T08:01:32Z", "updated_at": "2024-05-13T08:01:32Z", "movement_number": 8, "date": "2024-05-13T08:01:32.000Z", "cost_price": "10.0", "quantity": "10.0", "details": "Stock take adjustment", "reference": "", "stock_item": { "id": "568191f2d6b240a3b9cf672e6ebf6a21", "displayed_as": "glasses", "$path": "/stock_items/568191f2d6b240a3b9cf672e6ebf6a21", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-13T08:04:15Z", "links": [ { "href": "https://accounts-extra.sageone.com/advanced_uk/products_services/18209136", "rel": "alternate", "type": "text/html" } ], "deletable": false, "deactivatable": true, "used_on_recurring_invoice": false, "item_code": "glasses", "description": "glasses", "notes": "", "sales_ledger_account": { "id": "7a5e37b4884911ed84fa0252b90cda0d", "displayed_as": "Sales - Products (4000)", "$path": "/ledger_accounts/7a5e37b4884911ed84fa0252b90cda0d" }, "sales_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "purchase_ledger_account": { "id": "7a5ab138884911ed84fa0252b90cda0d", "displayed_as": "Stock - Raw Materials (1000)", "$path": "/ledger_accounts/7a5ab138884911ed84fa0252b90cda0d" }, "usual_supplier": { "id": "975c76ff2d3b4cd6b8d0faf37004ca73", "displayed_as": "McNally Computer Supplies (MCN001)", "$path": "/usual_suppliers/975c76ff2d3b4cd6b8d0faf37004ca73" }, "purchase_tax_rate": { "id": "GB_STANDARD", "displayed_as": "Standard 20.00%", "$path": "/tax_rates/GB_STANDARD" }, "cost_price": "10.0", "sales_prices": [ { "id": "1e5e182c1ffb4bfe9bf6715fb9a2951c", "displayed_as": "Sales Price", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-03T09:59:42Z", "price_name": "Sales Price", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "26024c3e7357462897edb896cc7084e9", "displayed_as": "Sales Price", "$path": "/product_sales_price_types/26024c3e7357462897edb896cc7084e9" } }, { "id": "63f3d2d4e3a2454fbb54ca92b05c9122", "displayed_as": "Trade", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-03T09:59:42Z", "price_name": "Trade", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "1d0fee218bcc425f803dc1bca63c3666", "displayed_as": "Trade", "$path": "/product_sales_price_types/1d0fee218bcc425f803dc1bca63c3666" } }, { "id": "b76b365b2aca4a00832371d5c7264728", "displayed_as": "Wholesale", "created_at": "2024-05-03T09:59:42Z", "updated_at": "2024-05-03T09:59:42Z", "price_name": "Wholesale", "price": "0.0", "price_includes_tax": false, "product_sales_price_type": { "id": "2c424fdefbe944aaa69cd1ce0c7277a3", "displayed_as": "Wholesale", "$path": "/product_sales_price_types/2c424fdefbe944aaa69cd1ce0c7277a3" } } ], "source_guid": null, "purchase_description": "", "reorder_level": "0.0", "reorder_quantity": "0.0", "location": "", "barcode": "", "supplier_part_number": "", "weight": 0, "measurement_unit": "kg", "weight_converted": "0.0", "active": true, "quantity_in_stock": "0.0", "last_cost_price": "5.0", "last_cost_price_stock_value": "0.0", "average_cost_price": "8.33", "average_cost_price_stock_value": "0.0", "cost_price_last_updated": "2024-05-13T08:02:03.000Z" } } } } } } } }, "tags": [ "Stock Movements" ], "operationId": "getStockMovementsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/stock_movements/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Stock Movement", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Stock Movement Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putStockMovements" }, "examples": { "Request example": { "value": { "stock_movement": { "stock_item_id": "string", "date": "2019-08-24", "quantity": 0.1, "cost_price": 0.1, "details": "string", "movement_number": "string", "reference": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Stock Movement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockMovement" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "movement_number": "stri", "date": "2019-08-24", "cost_price": 0.1, "quantity": 0.1, "details": "string", "reference": "string", "stock_item": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletable": true, "deactivatable": true, "used_on_recurring_invoice": true, "item_code": "string", "description": "string", "notes": "string", "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "usual_supplier": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "purchase_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "cost_price": 0.1, "sales_prices": [ { "id": "string", "displayed_as": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "price_name": "string", "price": 0.1, "price_includes_tax": true, "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "source_guid": "string", "purchase_description": "string", "reorder_level": 0.1, "reorder_quantity": 0.1, "location": "string", "barcode": "string", "supplier_part_number": "string", "weight": 0.1, "measurement_unit": "string", "weight_converted": 0.1, "active": true, "quantity_in_stock": 0.1, "last_cost_price": 0.1, "last_cost_price_stock_value": 0.1, "average_cost_price": 0.1, "average_cost_price_stock_value": 0.1, "cost_price_last_updated": "2019-08-24" } } } } } } } }, "tags": [ "Stock Movements" ], "operationId": "putStockMovementsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"stock_movement\":{\"stock_item_id\":\"string\",\"date\":\"2019-08-24\",\"quantity\":0.1,\"cost_price\":0.1,\"details\":\"string\",\"movement_number\":\"string\",\"reference\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"stock_movement\":{\"stock_item_id\":\"string\",\"date\":\"2019-08-24\",\"quantity\":0.1,\"cost_price\":0.1,\"details\":\"string\",\"movement_number\":\"string\",\"reference\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"stock_movement\":{\"stock_item_id\":\"string\",\"date\":\"2019-08-24\",\"quantity\":0.1,\"cost_price\":0.1,\"details\":\"string\",\"movement_number\":\"string\",\"reference\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"stock_movement\": {\n \"stock_item_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"quantity\": 0.1,\n \"cost_price\": 0.1,\n \"details\": \"string\",\n \"movement_number\": \"string\",\n \"reference\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_movements/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n stock_movement: {\n stock_item_id: 'string',\n date: '2019-08-24',\n quantity: 0.1,\n cost_price: 0.1,\n details: 'string',\n movement_number: 'string',\n reference: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"stock_movement\\\":{\\\"stock_item_id\\\":\\\"string\\\",\\\"date\\\":\\\"2019-08-24\\\",\\\"quantity\\\":0.1,\\\"cost_price\\\":0.1,\\\"details\\\":\\\"string\\\",\\\"movement_number\\\":\\\"string\\\",\\\"reference\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/stock_movements/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\"\n\npayload = {\"stock_movement\": {\n \"stock_item_id\": \"string\",\n \"date\": \"2019-08-24\",\n \"quantity\": 0.1,\n \"cost_price\": 0.1,\n \"details\": \"string\",\n \"movement_number\": \"string\",\n \"reference\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Stock Movement", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Stock Movement Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Stock Movement" } }, "tags": [ "Stock Movements" ], "operationId": "deleteStockMovementsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/stock_movements/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/stock_movements/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/stock_movements/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/analysis_type_categories": { "get": { "summary": "Returns all Analysis Type Categories", "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 `Settings`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Analysis Type Categories 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "analysis_type_level", "description": "Use this to filter Analysis Type Categories by analysis_type_level", "required": false, "schema": { "type": "string", "enum": [ "TRANSACTION", "GROUP" ] } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Analysis Type Categories per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Analysis Type Categories", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Analysis Type Categories (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Analysis Type Categories", "content": { "application/json": { "examples": { "response": { "value": { "$total": 18, "$page": 1, "$next": "/analysis_type_categories?page=2&items_per_page=10", "$back": null, "$itemsPerPage": 10, "$items": [ { "id": "64d22f88e73f44a99823bb1487d74082", "displayed_as": "Department 1", "$path": "/analysis_type_categories/64d22f88e73f44a99823bb1487d74082" }, { "id": "730826e18686449eab86de25343eff84", "displayed_as": "Department 2", "$path": "/analysis_type_categories/730826e18686449eab86de25343eff84" }, { "id": "028c8388209646f8a603801d70fa7614", "displayed_as": "Department 3", "$path": "/analysis_type_categories/028c8388209646f8a603801d70fa7614" }, { "id": "269a7ed9dd21409f89ee7c498d1e3ac5", "displayed_as": "Customer Group 1", "$path": "/analysis_type_categories/269a7ed9dd21409f89ee7c498d1e3ac5" }, { "id": "3c39c4aa300342d38200838a1570c337", "displayed_as": "Customer Group 2", "$path": "/analysis_type_categories/3c39c4aa300342d38200838a1570c337" }, { "id": "a9fc90029b9e48f3ba95c0788c808b64", "displayed_as": "Customer Group 3", "$path": "/analysis_type_categories/a9fc90029b9e48f3ba95c0788c808b64" }, { "id": "2c6b1b1c7df34e6b87c31dc8a5370050", "displayed_as": "Cost Centre 1", "$path": "/analysis_type_categories/2c6b1b1c7df34e6b87c31dc8a5370050" }, { "id": "4fe3b795089c45619137b3ac490345e1", "displayed_as": "Cost Centre 2", "$path": "/analysis_type_categories/4fe3b795089c45619137b3ac490345e1" }, { "id": "4ae5c5a5c05b4d64b62ac68d764f6eaf", "displayed_as": "Cost Centre 3", "$path": "/analysis_type_categories/4ae5c5a5c05b4d64b62ac68d764f6eaf" }, { "id": "c3edbe98162d46e8af69c4f051e7590f", "displayed_as": "Supplier Group 1", "$path": "/analysis_type_categories/c3edbe98162d46e8af69c4f051e7590f" } ] } } } } } } }, "tags": [ "Analysis Type Categories" ], "operationId": "getAnalysisTypeCategories", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/analysis_type_categories?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_type_categories\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"analysis_type_level\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Analysis Type Category", "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 `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postAnalysisTypeCategories" }, "examples": { "Request example": { "value": { "analysis_type_category": { "code": "string", "name": "string", "combined_id": "string", "analysis_type_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Analysis Type Category", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisTypeCategory" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Analysis Type Categories" ], "operationId": "postAnalysisTypeCategories", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/analysis_type_categories \\\n --header 'Content-Type: application/json' \\\n --data '{\"analysis_type_category\":{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"analysis_type_category\":{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}}' | \\\n http POST https://api.accounting.sage.com/v3.1/analysis_type_categories \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"analysis_type_category\":{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/analysis_type_categories", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"analysis_type_category\": {\n \"code\": \"string\",\n \"name\": \"string\",\n \"combined_id\": \"string\",\n \"analysis_type_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/analysis_type_categories\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_type_categories\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_type_categories\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n analysis_type_category: {\n code: 'string',\n name: 'string',\n combined_id: 'string',\n analysis_type_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_type_categories\"),\n Content = new StringContent(\"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_type_categories\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/analysis_type_categories\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_type_categories\"\n\npayload = {\"analysis_type_category\": {\n \"code\": \"string\",\n \"name\": \"string\",\n \"combined_id\": \"string\",\n \"analysis_type_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/analysis_type_categories/{key}": { "get": { "summary": "Returns a Analysis Type Category", "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 `Settings`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Analysis Type Category Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Analysis Type Category (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Analysis Type Category", "content": { "application/json": { "examples": { "response": { "value": { "id": "730826e18686449eab86de25343eff84", "displayed_as": "Department 2", "$path": "/analysis_type_categories/730826e18686449eab86de25343eff84", "created_at": "2022-12-30T13:54:28Z", "updated_at": "2022-12-30T13:54:28Z", "code": "02", "name": "Department 2", "combined_id": "5639877,17204944", "analysis_type": { "id": "747c9d74f062497aa20108eeecefe6d9", "displayed_as": "Department", "$path": "/analysis_types/747c9d74f062497aa20108eeecefe6d9" } } } } } } } }, "tags": [ "Analysis Type Categories" ], "operationId": "getAnalysisTypeCategoriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/analysis_type_categories/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Analysis Type Category", "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 `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Analysis Type Category Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putAnalysisTypeCategories" }, "examples": { "Request example": { "value": { "analysis_type_category": { "code": "string", "name": "string", "combined_id": "string", "analysis_type_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Analysis Type Category", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisTypeCategory" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Analysis Type Categories" ], "operationId": "putAnalysisTypeCategoriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"analysis_type_category\":{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"analysis_type_category\":{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"analysis_type_category\":{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"analysis_type_category\": {\n \"code\": \"string\",\n \"name\": \"string\",\n \"combined_id\": \"string\",\n \"analysis_type_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_type_categories/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n analysis_type_category: {\n code: 'string',\n name: 'string',\n combined_id: 'string',\n analysis_type_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"analysis_type_category\\\":{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/analysis_type_categories/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\"\n\npayload = {\"analysis_type_category\": {\n \"code\": \"string\",\n \"name\": \"string\",\n \"combined_id\": \"string\",\n \"analysis_type_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Analysis Type Category", "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 `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Analysis Type Category Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Analysis Type Category" } }, "tags": [ "Analysis Type Categories" ], "operationId": "deleteAnalysisTypeCategoriesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_type_categories/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/analysis_type_categories/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_type_categories/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/analysis_types": { "get": { "summary": "Returns all Analysis Types", "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 `Settings`: Full Access", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Analysis Types 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "analysis_type_level", "description": "Use this to filter Analysis Types by analysis_type_level", "required": false, "schema": { "type": "string", "enum": [ "TRANSACTION", "GROUP" ] } }, { "in": "query", "name": "search", "description": "Use this to filter by the item code or description", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Analysis Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Analysis Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Analysis Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Analysis Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 6, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "747c9d74f062497aa20108eeecefe6d9", "displayed_as": "Department", "$path": "/analysis_types/747c9d74f062497aa20108eeecefe6d9" }, { "id": "cb12dccacc1d464dbae14f74a15c3c2e", "displayed_as": "Customer Group", "$path": "/analysis_types/cb12dccacc1d464dbae14f74a15c3c2e" }, { "id": "d79f361e3720435a91a6035541c58d91", "displayed_as": "Cost Centre", "$path": "/analysis_types/d79f361e3720435a91a6035541c58d91" }, { "id": "63298b622dfc4b93b94612482bbcc8b7", "displayed_as": "Supplier Group", "$path": "/analysis_types/63298b622dfc4b93b94612482bbcc8b7" }, { "id": "10c466c30b0e48a2a7e535159adc27ac", "displayed_as": "Project", "$path": "/analysis_types/10c466c30b0e48a2a7e535159adc27ac" }, { "id": "e283dbdd5ada4354890db1cba9c6414f", "displayed_as": "Product Group", "$path": "/analysis_types/e283dbdd5ada4354890db1cba9c6414f" } ] } } } } } } }, "tags": [ "Analysis Types" ], "operationId": "getAnalysisTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/analysis_types?updated_or_created_since=2015-10-27T16%3A24%3A52Z&analysis_type_level=SOME_STRING_VALUE&search=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_types\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"analysis_type_level\":\"SOME_STRING_VALUE\",\"search\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/analysis_types/{key}": { "get": { "summary": "Returns a Analysis Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Analysis Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Analysis Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Analysis Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "747c9d74f062497aa20108eeecefe6d9", "displayed_as": "Department", "$path": "/analysis_types/747c9d74f062497aa20108eeecefe6d9", "created_at": "2022-12-30T13:54:28Z", "updated_at": "2023-03-03T16:20:14Z", "active_areas": [ "SALES", "EXPENSES", "BANKING", "JOURNALS" ], "analysis_type_level": { "id": 1, "name": "TRANSACTION_LEVEL", "identifier": "TRANSACTION" }, "analysis_type_categories": [ { "id": "64d22f88e73f44a99823bb1487d74082", "displayed_as": "Department 1", "$path": "/analysis_type_categories/64d22f88e73f44a99823bb1487d74082", "created_at": "2022-12-30T13:54:28Z", "updated_at": "2022-12-30T13:54:28Z", "code": "01", "name": "Department 1", "combined_id": "5639877,17204943", "analysis_type": { "id": "747c9d74f062497aa20108eeecefe6d9", "displayed_as": "Department", "$path": "/analysis_types/747c9d74f062497aa20108eeecefe6d9" } }, { "id": "730826e18686449eab86de25343eff84", "displayed_as": "Department 2", "$path": "/analysis_type_categories/730826e18686449eab86de25343eff84", "created_at": "2022-12-30T13:54:28Z", "updated_at": "2022-12-30T13:54:28Z", "code": "02", "name": "Department 2", "combined_id": "5639877,17204944", "analysis_type": { "id": "747c9d74f062497aa20108eeecefe6d9", "displayed_as": "Department", "$path": "/analysis_types/747c9d74f062497aa20108eeecefe6d9" } }, { "id": "028c8388209646f8a603801d70fa7614", "displayed_as": "Department 3", "$path": "/analysis_type_categories/028c8388209646f8a603801d70fa7614", "created_at": "2022-12-30T13:54:28Z", "updated_at": "2022-12-30T13:54:28Z", "code": "03", "name": "Department 3", "combined_id": "5639877,17204945", "analysis_type": { "id": "747c9d74f062497aa20108eeecefe6d9", "displayed_as": "Department", "$path": "/analysis_types/747c9d74f062497aa20108eeecefe6d9" } } ], "name": "Department" } } } } } } }, "tags": [ "Analysis Types" ], "operationId": "getAnalysisTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/analysis_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Analysis Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Analysis Type Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putAnalysisTypes" }, "examples": { "Request example": { "value": { "analysis_type": { "active_areas": [ "string" ], "analysis_type_level": [ "string" ], "name": "string", "analysis_type_categories": [ { "code": "string", "name": "string", "combined_id": "string", "analysis_type_id": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Analysis Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisType" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "active_areas": [ null ], "analysis_type_level": [ null ], "analysis_type_categories": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "code": "string", "name": "string", "combined_id": "string", "analysis_type": { "id": "string", "displayed_as": "string", "$path": "string" } } ], "name": "string" } } } } } } }, "tags": [ "Analysis Types" ], "operationId": "putAnalysisTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"analysis_type\":{\"active_areas\":[\"string\"],\"analysis_type_level\":[\"string\"],\"name\":\"string\",\"analysis_type_categories\":[{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"analysis_type\":{\"active_areas\":[\"string\"],\"analysis_type_level\":[\"string\"],\"name\":\"string\",\"analysis_type_categories\":[{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"analysis_type\":{\"active_areas\":[\"string\"],\"analysis_type_level\":[\"string\"],\"name\":\"string\",\"analysis_type_categories\":[{\"code\":\"string\",\"name\":\"string\",\"combined_id\":\"string\",\"analysis_type_id\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"analysis_type\": {\n \"active_areas\": [\n \"string\"\n ],\n \"analysis_type_level\": [\n \"string\"\n ],\n \"name\": \"string\",\n \"analysis_type_categories\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"combined_id\": \"string\",\n \"analysis_type_id\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"analysis_type\\\":{\\\"active_areas\\\":[\\\"string\\\"],\\\"analysis_type_level\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/analysis_types/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n analysis_type: {\n active_areas: ['string'],\n analysis_type_level: ['string'],\n name: 'string',\n analysis_type_categories: [\n {\n code: 'string',\n name: 'string',\n combined_id: 'string',\n analysis_type_id: 'string'\n }\n ]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"analysis_type\\\":{\\\"active_areas\\\":[\\\"string\\\"],\\\"analysis_type_level\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"analysis_type\\\":{\\\"active_areas\\\":[\\\"string\\\"],\\\"analysis_type_level\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"analysis_type\\\":{\\\"active_areas\\\":[\\\"string\\\"],\\\"analysis_type_level\\\":[\\\"string\\\"],\\\"name\\\":\\\"string\\\",\\\"analysis_type_categories\\\":[{\\\"code\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"combined_id\\\":\\\"string\\\",\\\"analysis_type_id\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/analysis_types/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/analysis_types/%7Bkey%7D\"\n\npayload = {\"analysis_type\": {\n \"active_areas\": [\"string\"],\n \"analysis_type_level\": [\"string\"],\n \"name\": \"string\",\n \"analysis_type_categories\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"combined_id\": \"string\",\n \"analysis_type_id\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/business_activity_types": { "get": { "summary": "Returns all Business Activity Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Business Classifications per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Business Classifications", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Business Classifications (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Business Activity Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessActivityType" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Business Activity Types" ], "operationId": "getBusinessActivityTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/business_activity_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_activity_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/business_activity_types/{key}": { "get": { "summary": "Returns a Business Activity Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท", "parameters": [ { "in": "path", "name": "key", "description": "The Business Activity Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Business Classification (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Business Activity Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessActivityType" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Business Activity Types" ], "operationId": "getBusinessActivityTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/business_activity_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_activity_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/business_settings": { "get": { "summary": "Returns all Business Settings", "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 `Settings`: Full Access, Read Only", "responses": { "200": { "description": "Returns all Business Settings", "content": { "application/json": { "examples": { "response": { "value": { "$path": "/business_settings", "siret": null, "management_centre_member": false, "smart_transaction_enabled": false, "rcs_number": null, "share_capital": null, "business_activity_type": null, "legal_form_type": null, "auxiliary_accounts_visible": false, "default_ledger_accounts": { "bank_charges_ledger_account": { "id": "7a6282e7884911ed84fa0252b90cda0d", "displayed_as": "Bank Charges and Interest (7900)", "$path": "/ledger_accounts/7a6282e7884911ed84fa0252b90cda0d" }, "bank_interest_received_ledger_account": { "id": "7a6282e7884911ed84fa0252b90cda0d", "displayed_as": "Bank Charges and Interest (7900)", "$path": "/ledger_accounts/7a6282e7884911ed84fa0252b90cda0d" }, "bank_interest_charges_paid_ledger_account": { "id": "7a6282e7884911ed84fa0252b90cda0d", "displayed_as": "Bank Charges and Interest (7900)", "$path": "/ledger_accounts/7a6282e7884911ed84fa0252b90cda0d" }, "exchange_rate_gains_ledger_account": { "id": "7a62f9e6884911ed84fa0252b90cda0d", "displayed_as": "Exchange Rate Gains and Losses (8260)", "$path": "/ledger_accounts/7a62f9e6884911ed84fa0252b90cda0d" }, "exchange_rate_losses_ledger_account": { "id": "7a62f9e6884911ed84fa0252b90cda0d", "displayed_as": "Exchange Rate Gains and Losses (8260)", "$path": "/ledger_accounts/7a62f9e6884911ed84fa0252b90cda0d" }, "sales_ledger_account": { "id": "7a5ecfcf884911ed84fa0252b90cda0d", "displayed_as": "Other income (4900)", "$path": "/ledger_accounts/7a5ecfcf884911ed84fa0252b90cda0d" }, "sales_discount_ledger_account": { "id": "7a5e5edc884911ed84fa0252b90cda0d", "displayed_as": "Sales Discounts (4020)", "$path": "/ledger_accounts/7a5e5edc884911ed84fa0252b90cda0d" }, "purchase_ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "purchase_discount_ledger_account": { "id": "7a5f4fe4884911ed84fa0252b90cda0d", "displayed_as": "Purchase Discounts (5010)", "$path": "/ledger_accounts/7a5f4fe4884911ed84fa0252b90cda0d" }, "product_sales_ledger_account": { "id": "7a5e37b4884911ed84fa0252b90cda0d", "displayed_as": "Sales - Products (4000)", "$path": "/ledger_accounts/7a5e37b4884911ed84fa0252b90cda0d" }, "product_purchase_ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "service_sales_ledger_account": { "id": "7a639255884911ed84fa0252b90cda0d", "displayed_as": "Sales - Services (4010)", "$path": "/ledger_accounts/7a639255884911ed84fa0252b90cda0d" }, "service_purchase_ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "stock_purchase_ledger_account": { "id": "7a5ab138884911ed84fa0252b90cda0d", "displayed_as": "Stock - Raw Materials (1000)", "$path": "/ledger_accounts/7a5ab138884911ed84fa0252b90cda0d" }, "other_receipt_ledger_account": { "id": "7a5ecfcf884911ed84fa0252b90cda0d", "displayed_as": "Other income (4900)", "$path": "/ledger_accounts/7a5ecfcf884911ed84fa0252b90cda0d" }, "other_payment_ledger_account": { "id": "7a5f27a2884911ed84fa0252b90cda0d", "displayed_as": "Cost of Sales - Goods (5000)", "$path": "/ledger_accounts/7a5f27a2884911ed84fa0252b90cda0d" }, "customer_receipt_discount_ledger_account": { "id": "7a5e5edc884911ed84fa0252b90cda0d", "displayed_as": "Sales Discounts (4020)", "$path": "/ledger_accounts/7a5e5edc884911ed84fa0252b90cda0d" }, "vendor_payment_discount_ledger_account": { "id": "7a5f4fe4884911ed84fa0252b90cda0d", "displayed_as": "Purchase Discounts (5010)", "$path": "/ledger_accounts/7a5f4fe4884911ed84fa0252b90cda0d" }, "carriage_ledger_account": { "id": "7a5ef5d8884911ed84fa0252b90cda0d", "displayed_as": "Carriage on Sales (4910)", "$path": "/ledger_accounts/7a5ef5d8884911ed84fa0252b90cda0d" } }, "business_type": { "id": "LIMITED", "displayed_as": "Limited Company/LLP - we're registered at Companies House", "$path": "/business_types/LIMITED", "name": "Limited Company/LLP", "description": "we're registered at Companies House" }, "country_of_registration": { "id": "ENGLAND_AND_WALES", "displayed_as": "England and Wales", "$path": "/countries_of_registration/ENGLAND_AND_WALES" }, "business_created_at": "2022-12-30T13:54:24Z", "updated_at": "2024-10-18T01:09:36Z", "wizard_complete": true } } } } } } }, "tags": [ "Business Settings" ], "operationId": "getBusinessSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/business_settings", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/business_settings", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/business_settings", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/business_settings\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_settings\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_settings\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_settings\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_settings\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/business_settings\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_settings\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Business Settings", "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 `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putBusinessSettings" }, "examples": { "Request example": { "value": { "business_settings": { "siret": "string", "management_centre_member": true, "rcs_number": "string", "share_capital": 0.1, "business_activity_type_id": "string", "legal_form_type_id": "string", "auxiliary_accounts_visible": true, "business_type_id": "string", "country_of_registration_id": "string", "wizard_complete": true, "default_ledger_accounts": { "bank_charges_ledger_account_id": "string", "bank_interest_received_ledger_account_id": "string", "bank_interest_charges_paid_ledger_account_id": "string", "exchange_rate_gains_ledger_account_id": "string", "exchange_rate_losses_ledger_account_id": "string", "sales_ledger_account_id": "string", "sales_discount_ledger_account_id": "string", "purchase_ledger_account_id": "string", "purchase_discount_ledger_account_id": "string", "product_sales_ledger_account_id": "string", "product_purchase_ledger_account_id": "string", "service_sales_ledger_account_id": "string", "service_purchase_ledger_account_id": "string", "stock_purchase_ledger_account_id": "string", "other_receipt_ledger_account_id": "string", "other_payment_ledger_account_id": "string", "customer_receipt_discount_ledger_account_id": "string", "vendor_payment_discount_ledger_account_id": "string", "carriage_ledger_account_id": "string" } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Business Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessSettings" }, "examples": { "200 response example": { "value": { "$path": "string", "siret": "string", "management_centre_member": true, "rcs_number": "string", "share_capital": 0.1, "business_activity_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "legal_form_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "auxiliary_accounts_visible": true, "default_ledger_accounts": { "bank_charges_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_interest_received_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "bank_interest_charges_paid_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate_gains_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "exchange_rate_losses_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_discount_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "purchase_discount_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "product_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "product_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "service_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "service_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "stock_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "other_receipt_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "other_payment_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "customer_receipt_discount_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "vendor_payment_discount_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "carriage_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string" } }, "business_type": { "id": "string", "displayed_as": "string", "$path": "string", "name": "string", "description": "string" }, "country_of_registration": { "id": "string", "displayed_as": "string", "$path": "string" }, "business_created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "wizard_complete": true } } } } } } }, "tags": [ "Business Settings" ], "operationId": "putBusinessSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/business_settings \\\n --header 'Content-Type: application/json' \\\n --data '{\"business_settings\":{\"siret\":\"string\",\"management_centre_member\":true,\"rcs_number\":\"string\",\"share_capital\":0.1,\"business_activity_type_id\":\"string\",\"legal_form_type_id\":\"string\",\"auxiliary_accounts_visible\":true,\"business_type_id\":\"string\",\"country_of_registration_id\":\"string\",\"wizard_complete\":true,\"default_ledger_accounts\":{\"bank_charges_ledger_account_id\":\"string\",\"bank_interest_received_ledger_account_id\":\"string\",\"bank_interest_charges_paid_ledger_account_id\":\"string\",\"exchange_rate_gains_ledger_account_id\":\"string\",\"exchange_rate_losses_ledger_account_id\":\"string\",\"sales_ledger_account_id\":\"string\",\"sales_discount_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"purchase_discount_ledger_account_id\":\"string\",\"product_sales_ledger_account_id\":\"string\",\"product_purchase_ledger_account_id\":\"string\",\"service_sales_ledger_account_id\":\"string\",\"service_purchase_ledger_account_id\":\"string\",\"stock_purchase_ledger_account_id\":\"string\",\"other_receipt_ledger_account_id\":\"string\",\"other_payment_ledger_account_id\":\"string\",\"customer_receipt_discount_ledger_account_id\":\"string\",\"vendor_payment_discount_ledger_account_id\":\"string\",\"carriage_ledger_account_id\":\"string\"}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"business_settings\":{\"siret\":\"string\",\"management_centre_member\":true,\"rcs_number\":\"string\",\"share_capital\":0.1,\"business_activity_type_id\":\"string\",\"legal_form_type_id\":\"string\",\"auxiliary_accounts_visible\":true,\"business_type_id\":\"string\",\"country_of_registration_id\":\"string\",\"wizard_complete\":true,\"default_ledger_accounts\":{\"bank_charges_ledger_account_id\":\"string\",\"bank_interest_received_ledger_account_id\":\"string\",\"bank_interest_charges_paid_ledger_account_id\":\"string\",\"exchange_rate_gains_ledger_account_id\":\"string\",\"exchange_rate_losses_ledger_account_id\":\"string\",\"sales_ledger_account_id\":\"string\",\"sales_discount_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"purchase_discount_ledger_account_id\":\"string\",\"product_sales_ledger_account_id\":\"string\",\"product_purchase_ledger_account_id\":\"string\",\"service_sales_ledger_account_id\":\"string\",\"service_purchase_ledger_account_id\":\"string\",\"stock_purchase_ledger_account_id\":\"string\",\"other_receipt_ledger_account_id\":\"string\",\"other_payment_ledger_account_id\":\"string\",\"customer_receipt_discount_ledger_account_id\":\"string\",\"vendor_payment_discount_ledger_account_id\":\"string\",\"carriage_ledger_account_id\":\"string\"}}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/business_settings \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"business_settings\":{\"siret\":\"string\",\"management_centre_member\":true,\"rcs_number\":\"string\",\"share_capital\":0.1,\"business_activity_type_id\":\"string\",\"legal_form_type_id\":\"string\",\"auxiliary_accounts_visible\":true,\"business_type_id\":\"string\",\"country_of_registration_id\":\"string\",\"wizard_complete\":true,\"default_ledger_accounts\":{\"bank_charges_ledger_account_id\":\"string\",\"bank_interest_received_ledger_account_id\":\"string\",\"bank_interest_charges_paid_ledger_account_id\":\"string\",\"exchange_rate_gains_ledger_account_id\":\"string\",\"exchange_rate_losses_ledger_account_id\":\"string\",\"sales_ledger_account_id\":\"string\",\"sales_discount_ledger_account_id\":\"string\",\"purchase_ledger_account_id\":\"string\",\"purchase_discount_ledger_account_id\":\"string\",\"product_sales_ledger_account_id\":\"string\",\"product_purchase_ledger_account_id\":\"string\",\"service_sales_ledger_account_id\":\"string\",\"service_purchase_ledger_account_id\":\"string\",\"stock_purchase_ledger_account_id\":\"string\",\"other_receipt_ledger_account_id\":\"string\",\"other_payment_ledger_account_id\":\"string\",\"customer_receipt_discount_ledger_account_id\":\"string\",\"vendor_payment_discount_ledger_account_id\":\"string\",\"carriage_ledger_account_id\":\"string\"}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/business_settings", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"business_settings\": {\n \"siret\": \"string\",\n \"management_centre_member\": true,\n \"rcs_number\": \"string\",\n \"share_capital\": 0.1,\n \"business_activity_type_id\": \"string\",\n \"legal_form_type_id\": \"string\",\n \"auxiliary_accounts_visible\": true,\n \"business_type_id\": \"string\",\n \"country_of_registration_id\": \"string\",\n \"wizard_complete\": true,\n \"default_ledger_accounts\": {\n \"bank_charges_ledger_account_id\": \"string\",\n \"bank_interest_received_ledger_account_id\": \"string\",\n \"bank_interest_charges_paid_ledger_account_id\": \"string\",\n \"exchange_rate_gains_ledger_account_id\": \"string\",\n \"exchange_rate_losses_ledger_account_id\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"sales_discount_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"purchase_discount_ledger_account_id\": \"string\",\n \"product_sales_ledger_account_id\": \"string\",\n \"product_purchase_ledger_account_id\": \"string\",\n \"service_sales_ledger_account_id\": \"string\",\n \"service_purchase_ledger_account_id\": \"string\",\n \"stock_purchase_ledger_account_id\": \"string\",\n \"other_receipt_ledger_account_id\": \"string\",\n \"other_payment_ledger_account_id\": \"string\",\n \"customer_receipt_discount_ledger_account_id\": \"string\",\n \"vendor_payment_discount_ledger_account_id\": \"string\",\n \"carriage_ledger_account_id\": \"string\"\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/business_settings\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_settings\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"business_settings\\\":{\\\"siret\\\":\\\"string\\\",\\\"management_centre_member\\\":true,\\\"rcs_number\\\":\\\"string\\\",\\\"share_capital\\\":0.1,\\\"business_activity_type_id\\\":\\\"string\\\",\\\"legal_form_type_id\\\":\\\"string\\\",\\\"auxiliary_accounts_visible\\\":true,\\\"business_type_id\\\":\\\"string\\\",\\\"country_of_registration_id\\\":\\\"string\\\",\\\"wizard_complete\\\":true,\\\"default_ledger_accounts\\\":{\\\"bank_charges_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_received_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_charges_paid_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_gains_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_losses_ledger_account_id\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"sales_discount_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"purchase_discount_ledger_account_id\\\":\\\"string\\\",\\\"product_sales_ledger_account_id\\\":\\\"string\\\",\\\"product_purchase_ledger_account_id\\\":\\\"string\\\",\\\"service_sales_ledger_account_id\\\":\\\"string\\\",\\\"service_purchase_ledger_account_id\\\":\\\"string\\\",\\\"stock_purchase_ledger_account_id\\\":\\\"string\\\",\\\"other_receipt_ledger_account_id\\\":\\\"string\\\",\\\"other_payment_ledger_account_id\\\":\\\"string\\\",\\\"customer_receipt_discount_ledger_account_id\\\":\\\"string\\\",\\\"vendor_payment_discount_ledger_account_id\\\":\\\"string\\\",\\\"carriage_ledger_account_id\\\":\\\"string\\\"}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_settings\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n business_settings: {\n siret: 'string',\n management_centre_member: true,\n rcs_number: 'string',\n share_capital: 0.1,\n business_activity_type_id: 'string',\n legal_form_type_id: 'string',\n auxiliary_accounts_visible: true,\n business_type_id: 'string',\n country_of_registration_id: 'string',\n wizard_complete: true,\n default_ledger_accounts: {\n bank_charges_ledger_account_id: 'string',\n bank_interest_received_ledger_account_id: 'string',\n bank_interest_charges_paid_ledger_account_id: 'string',\n exchange_rate_gains_ledger_account_id: 'string',\n exchange_rate_losses_ledger_account_id: 'string',\n sales_ledger_account_id: 'string',\n sales_discount_ledger_account_id: 'string',\n purchase_ledger_account_id: 'string',\n purchase_discount_ledger_account_id: 'string',\n product_sales_ledger_account_id: 'string',\n product_purchase_ledger_account_id: 'string',\n service_sales_ledger_account_id: 'string',\n service_purchase_ledger_account_id: 'string',\n stock_purchase_ledger_account_id: 'string',\n other_receipt_ledger_account_id: 'string',\n other_payment_ledger_account_id: 'string',\n customer_receipt_discount_ledger_account_id: 'string',\n vendor_payment_discount_ledger_account_id: 'string',\n carriage_ledger_account_id: 'string'\n }\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_settings\"),\n Content = new StringContent(\"{\\\"business_settings\\\":{\\\"siret\\\":\\\"string\\\",\\\"management_centre_member\\\":true,\\\"rcs_number\\\":\\\"string\\\",\\\"share_capital\\\":0.1,\\\"business_activity_type_id\\\":\\\"string\\\",\\\"legal_form_type_id\\\":\\\"string\\\",\\\"auxiliary_accounts_visible\\\":true,\\\"business_type_id\\\":\\\"string\\\",\\\"country_of_registration_id\\\":\\\"string\\\",\\\"wizard_complete\\\":true,\\\"default_ledger_accounts\\\":{\\\"bank_charges_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_received_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_charges_paid_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_gains_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_losses_ledger_account_id\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"sales_discount_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"purchase_discount_ledger_account_id\\\":\\\"string\\\",\\\"product_sales_ledger_account_id\\\":\\\"string\\\",\\\"product_purchase_ledger_account_id\\\":\\\"string\\\",\\\"service_sales_ledger_account_id\\\":\\\"string\\\",\\\"service_purchase_ledger_account_id\\\":\\\"string\\\",\\\"stock_purchase_ledger_account_id\\\":\\\"string\\\",\\\"other_receipt_ledger_account_id\\\":\\\"string\\\",\\\"other_payment_ledger_account_id\\\":\\\"string\\\",\\\"customer_receipt_discount_ledger_account_id\\\":\\\"string\\\",\\\"vendor_payment_discount_ledger_account_id\\\":\\\"string\\\",\\\"carriage_ledger_account_id\\\":\\\"string\\\"}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_settings\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"business_settings\\\":{\\\"siret\\\":\\\"string\\\",\\\"management_centre_member\\\":true,\\\"rcs_number\\\":\\\"string\\\",\\\"share_capital\\\":0.1,\\\"business_activity_type_id\\\":\\\"string\\\",\\\"legal_form_type_id\\\":\\\"string\\\",\\\"auxiliary_accounts_visible\\\":true,\\\"business_type_id\\\":\\\"string\\\",\\\"country_of_registration_id\\\":\\\"string\\\",\\\"wizard_complete\\\":true,\\\"default_ledger_accounts\\\":{\\\"bank_charges_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_received_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_charges_paid_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_gains_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_losses_ledger_account_id\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"sales_discount_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"purchase_discount_ledger_account_id\\\":\\\"string\\\",\\\"product_sales_ledger_account_id\\\":\\\"string\\\",\\\"product_purchase_ledger_account_id\\\":\\\"string\\\",\\\"service_sales_ledger_account_id\\\":\\\"string\\\",\\\"service_purchase_ledger_account_id\\\":\\\"string\\\",\\\"stock_purchase_ledger_account_id\\\":\\\"string\\\",\\\"other_receipt_ledger_account_id\\\":\\\"string\\\",\\\"other_payment_ledger_account_id\\\":\\\"string\\\",\\\"customer_receipt_discount_ledger_account_id\\\":\\\"string\\\",\\\"vendor_payment_discount_ledger_account_id\\\":\\\"string\\\",\\\"carriage_ledger_account_id\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"business_settings\\\":{\\\"siret\\\":\\\"string\\\",\\\"management_centre_member\\\":true,\\\"rcs_number\\\":\\\"string\\\",\\\"share_capital\\\":0.1,\\\"business_activity_type_id\\\":\\\"string\\\",\\\"legal_form_type_id\\\":\\\"string\\\",\\\"auxiliary_accounts_visible\\\":true,\\\"business_type_id\\\":\\\"string\\\",\\\"country_of_registration_id\\\":\\\"string\\\",\\\"wizard_complete\\\":true,\\\"default_ledger_accounts\\\":{\\\"bank_charges_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_received_ledger_account_id\\\":\\\"string\\\",\\\"bank_interest_charges_paid_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_gains_ledger_account_id\\\":\\\"string\\\",\\\"exchange_rate_losses_ledger_account_id\\\":\\\"string\\\",\\\"sales_ledger_account_id\\\":\\\"string\\\",\\\"sales_discount_ledger_account_id\\\":\\\"string\\\",\\\"purchase_ledger_account_id\\\":\\\"string\\\",\\\"purchase_discount_ledger_account_id\\\":\\\"string\\\",\\\"product_sales_ledger_account_id\\\":\\\"string\\\",\\\"product_purchase_ledger_account_id\\\":\\\"string\\\",\\\"service_sales_ledger_account_id\\\":\\\"string\\\",\\\"service_purchase_ledger_account_id\\\":\\\"string\\\",\\\"stock_purchase_ledger_account_id\\\":\\\"string\\\",\\\"other_receipt_ledger_account_id\\\":\\\"string\\\",\\\"other_payment_ledger_account_id\\\":\\\"string\\\",\\\"customer_receipt_discount_ledger_account_id\\\":\\\"string\\\",\\\"vendor_payment_discount_ledger_account_id\\\":\\\"string\\\",\\\"carriage_ledger_account_id\\\":\\\"string\\\"}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/business_settings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_settings\"\n\npayload = {\"business_settings\": {\n \"siret\": \"string\",\n \"management_centre_member\": True,\n \"rcs_number\": \"string\",\n \"share_capital\": 0.1,\n \"business_activity_type_id\": \"string\",\n \"legal_form_type_id\": \"string\",\n \"auxiliary_accounts_visible\": True,\n \"business_type_id\": \"string\",\n \"country_of_registration_id\": \"string\",\n \"wizard_complete\": True,\n \"default_ledger_accounts\": {\n \"bank_charges_ledger_account_id\": \"string\",\n \"bank_interest_received_ledger_account_id\": \"string\",\n \"bank_interest_charges_paid_ledger_account_id\": \"string\",\n \"exchange_rate_gains_ledger_account_id\": \"string\",\n \"exchange_rate_losses_ledger_account_id\": \"string\",\n \"sales_ledger_account_id\": \"string\",\n \"sales_discount_ledger_account_id\": \"string\",\n \"purchase_ledger_account_id\": \"string\",\n \"purchase_discount_ledger_account_id\": \"string\",\n \"product_sales_ledger_account_id\": \"string\",\n \"product_purchase_ledger_account_id\": \"string\",\n \"service_sales_ledger_account_id\": \"string\",\n \"service_purchase_ledger_account_id\": \"string\",\n \"stock_purchase_ledger_account_id\": \"string\",\n \"other_receipt_ledger_account_id\": \"string\",\n \"other_payment_ledger_account_id\": \"string\",\n \"customer_receipt_discount_ledger_account_id\": \"string\",\n \"vendor_payment_discount_ledger_account_id\": \"string\",\n \"carriage_ledger_account_id\": \"string\"\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/business_types": { "get": { "summary": "Returns all Business Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of For Business Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of For Business Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the For Business Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Business Types", "content": { "application/json": { "examples": { "response": { "value": { "$total": 3, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "SOLE", "displayed_as": "Sole Trader or Small Business - I work for myself", "$path": "/business_types/SOLE" }, { "id": "PARTNER", "displayed_as": "Partnership - it's me and my business partner(s)", "$path": "/business_types/PARTNER" }, { "id": "LIMITED", "displayed_as": "Limited Company/LLP - we're registered at Companies House", "$path": "/business_types/LIMITED" } ] } } } } } } }, "tags": [ "Business Types" ], "operationId": "getBusinessTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/business_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/business_types/{key}": { "get": { "summary": "Returns a Business Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Business Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the For Business Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Business Type", "content": { "application/json": { "examples": { "response": { "value": { "id": "LIMITED", "displayed_as": "Limited Company/LLP - we're registered at Companies House", "$path": "/business_types/LIMITED", "name": "Limited Company/LLP", "description": "we're registered at Companies House" } } } } } } }, "tags": [ "Business Types" ], "operationId": "getBusinessTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/business_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/business_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/cis_settings": { "get": { "summary": "Returns all Cis Settings", "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 `Settings`: Full Access, Read Only", "responses": { "200": { "description": "Returns all Cis Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CisSettings" }, "examples": { "200 response example": { "value": { "$path": "string", "unique_tax_reference": "string", "contractor": true, "subcontractor": true, "accounts_office_reference": "string", "paye_reference": "string", "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Cis Settings" ], "operationId": "getCisSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/cis_settings", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/cis_settings", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/cis_settings", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/cis_settings\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/cis_settings\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/cis_settings\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/cis_settings\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/cis_settings\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/cis_settings\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/cis_settings\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Cis Settings", "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 `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putCisSettings" }, "examples": { "Request example": { "value": { "cis_settings": { "unique_tax_reference": "string", "contractor": true, "subcontractor": true, "accounts_office_reference": "string", "paye_reference": "string", "tax_rate_id": "string" } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Cis Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CisSettings" }, "examples": { "200 response example": { "value": { "$path": "string", "unique_tax_reference": "string", "contractor": true, "subcontractor": true, "accounts_office_reference": "string", "paye_reference": "string", "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } } }, "tags": [ "Cis Settings" ], "operationId": "putCisSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/cis_settings \\\n --header 'Content-Type: application/json' \\\n --data '{\"cis_settings\":{\"unique_tax_reference\":\"string\",\"contractor\":true,\"subcontractor\":true,\"accounts_office_reference\":\"string\",\"paye_reference\":\"string\",\"tax_rate_id\":\"string\"}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"cis_settings\":{\"unique_tax_reference\":\"string\",\"contractor\":true,\"subcontractor\":true,\"accounts_office_reference\":\"string\",\"paye_reference\":\"string\",\"tax_rate_id\":\"string\"}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/cis_settings \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"cis_settings\":{\"unique_tax_reference\":\"string\",\"contractor\":true,\"subcontractor\":true,\"accounts_office_reference\":\"string\",\"paye_reference\":\"string\",\"tax_rate_id\":\"string\"}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/cis_settings", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"cis_settings\": {\n \"unique_tax_reference\": \"string\",\n \"contractor\": true,\n \"subcontractor\": true,\n \"accounts_office_reference\": \"string\",\n \"paye_reference\": \"string\",\n \"tax_rate_id\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/cis_settings\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/cis_settings\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"cis_settings\\\":{\\\"unique_tax_reference\\\":\\\"string\\\",\\\"contractor\\\":true,\\\"subcontractor\\\":true,\\\"accounts_office_reference\\\":\\\"string\\\",\\\"paye_reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\"}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/cis_settings\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n cis_settings: {\n unique_tax_reference: 'string',\n contractor: true,\n subcontractor: true,\n accounts_office_reference: 'string',\n paye_reference: 'string',\n tax_rate_id: 'string'\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/cis_settings\"),\n Content = new StringContent(\"{\\\"cis_settings\\\":{\\\"unique_tax_reference\\\":\\\"string\\\",\\\"contractor\\\":true,\\\"subcontractor\\\":true,\\\"accounts_office_reference\\\":\\\"string\\\",\\\"paye_reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\"}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/cis_settings\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"cis_settings\\\":{\\\"unique_tax_reference\\\":\\\"string\\\",\\\"contractor\\\":true,\\\"subcontractor\\\":true,\\\"accounts_office_reference\\\":\\\"string\\\",\\\"paye_reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"cis_settings\\\":{\\\"unique_tax_reference\\\":\\\"string\\\",\\\"contractor\\\":true,\\\"subcontractor\\\":true,\\\"accounts_office_reference\\\":\\\"string\\\",\\\"paye_reference\\\":\\\"string\\\",\\\"tax_rate_id\\\":\\\"string\\\"}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/cis_settings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/cis_settings\"\n\npayload = {\"cis_settings\": {\n \"unique_tax_reference\": \"string\",\n \"contractor\": True,\n \"subcontractor\": True,\n \"accounts_office_reference\": \"string\",\n \"paye_reference\": \"string\",\n \"tax_rate_id\": \"string\"\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/financial_settings": { "get": { "summary": "Returns all Financial Settings", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access, Read Only", "responses": { "200": { "description": "Returns all Financial Settings", "content": { "application/json": { "examples": { "response": { "value": { "$path": "/financial_settings", "year_end_date": "2024-12-15", "year_end_lockdown_date": null, "accounting_type": "accrual", "accounts_start_date": "2022-01-01", "base_currency": { "id": "GBP", "displayed_as": "Pound Sterling (GBP)", "$path": "/currencies/GBP" }, "multi_currency_enabled": true, "use_live_exchange_rates": true, "mtd_activation_status": "enablable", "mtd_connected": false, "mtd_authenticated_date": "", "tax_scheme": { "id": "STANDARD", "displayed_as": "Standard", "$path": "/tax_schemes/STANDARD" }, "tax_return_frequency": { "id": "QUARTERLY", "displayed_as": "Quarterly", "$path": "/tax_return_frequencies/QUARTERLY" }, "tax_number": "987654321", "general_tax_number": "87654321", "tax_office": null, "default_irpf_rate": "0.0", "flat_rate_tax_percentage": null, "recoverable_percentage": null, "sales_tax_calculation": null, "purchase_tax_calculation": null, "updated_at": "2024-07-19T10:46:54Z", "postponed_accounting": false, "destination_vat": false, "exempt_from_vat": false } } } } } } }, "tags": [ "Financial Settings" ], "operationId": "getFinancialSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/financial_settings", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/financial_settings", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/financial_settings", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/financial_settings\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/financial_settings\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/financial_settings\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/financial_settings\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/financial_settings\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/financial_settings\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/financial_settings\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Financial Settings", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putFinancialSettings" }, "examples": { "Request example": { "value": { "financial_settings": { "year_end_date": "2019-08-24", "year_end_lockdown_date": "2019-08-24", "accounting_type": "string", "accounts_start_date": "2019-08-24", "base_currency_id": "string", "multi_currency_enabled": true, "use_live_exchange_rates": true, "mtd_activation_status": "string", "mtd_connected": true, "mtd_authenticated_date": "2019-08-24", "tax_scheme_id": "string", "tax_return_frequency_id": "string", "tax_number": "string", "general_tax_number": "string", "tax_office_id": "string", "default_irpf_rate": 0.1, "flat_rate_tax_percentage": 0.1, "recoverable_percentage": 0.1, "sales_tax_calculation": "string", "purchase_tax_calculation": "string", "postponed_accounting": true, "destination_vat": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Financial Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialSettings" }, "examples": { "200 response example": { "value": { "$path": "string", "year_end_date": "2019-08-24", "year_end_lockdown_date": "2019-08-24", "accounting_type": "string", "accounts_start_date": "2019-08-24", "base_currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "multi_currency_enabled": true, "use_live_exchange_rates": true, "mtd_activation_status": "string", "mtd_connected": true, "mtd_authenticated_date": "2019-08-24", "tax_scheme": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_return_frequency": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_number": "string", "general_tax_number": "string", "tax_office": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_irpf_rate": 0.1, "flat_rate_tax_percentage": 0.1, "recoverable_percentage": 0.1, "sales_tax_calculation": "string", "purchase_tax_calculation": "string", "updated_at": "2019-08-24T14:15:22Z", "postponed_accounting": true, "destination_vat": true } } } } } } }, "tags": [ "Financial Settings" ], "operationId": "putFinancialSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/financial_settings \\\n --header 'Content-Type: application/json' \\\n --data '{\"financial_settings\":{\"year_end_date\":\"2019-08-24\",\"year_end_lockdown_date\":\"2019-08-24\",\"accounting_type\":\"string\",\"accounts_start_date\":\"2019-08-24\",\"base_currency_id\":\"string\",\"multi_currency_enabled\":true,\"use_live_exchange_rates\":true,\"mtd_activation_status\":\"string\",\"mtd_connected\":true,\"mtd_authenticated_date\":\"2019-08-24\",\"tax_scheme_id\":\"string\",\"tax_return_frequency_id\":\"string\",\"tax_number\":\"string\",\"general_tax_number\":\"string\",\"tax_office_id\":\"string\",\"default_irpf_rate\":0.1,\"flat_rate_tax_percentage\":0.1,\"recoverable_percentage\":0.1,\"sales_tax_calculation\":\"string\",\"purchase_tax_calculation\":\"string\",\"postponed_accounting\":true,\"destination_vat\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"financial_settings\":{\"year_end_date\":\"2019-08-24\",\"year_end_lockdown_date\":\"2019-08-24\",\"accounting_type\":\"string\",\"accounts_start_date\":\"2019-08-24\",\"base_currency_id\":\"string\",\"multi_currency_enabled\":true,\"use_live_exchange_rates\":true,\"mtd_activation_status\":\"string\",\"mtd_connected\":true,\"mtd_authenticated_date\":\"2019-08-24\",\"tax_scheme_id\":\"string\",\"tax_return_frequency_id\":\"string\",\"tax_number\":\"string\",\"general_tax_number\":\"string\",\"tax_office_id\":\"string\",\"default_irpf_rate\":0.1,\"flat_rate_tax_percentage\":0.1,\"recoverable_percentage\":0.1,\"sales_tax_calculation\":\"string\",\"purchase_tax_calculation\":\"string\",\"postponed_accounting\":true,\"destination_vat\":true}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/financial_settings \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"financial_settings\":{\"year_end_date\":\"2019-08-24\",\"year_end_lockdown_date\":\"2019-08-24\",\"accounting_type\":\"string\",\"accounts_start_date\":\"2019-08-24\",\"base_currency_id\":\"string\",\"multi_currency_enabled\":true,\"use_live_exchange_rates\":true,\"mtd_activation_status\":\"string\",\"mtd_connected\":true,\"mtd_authenticated_date\":\"2019-08-24\",\"tax_scheme_id\":\"string\",\"tax_return_frequency_id\":\"string\",\"tax_number\":\"string\",\"general_tax_number\":\"string\",\"tax_office_id\":\"string\",\"default_irpf_rate\":0.1,\"flat_rate_tax_percentage\":0.1,\"recoverable_percentage\":0.1,\"sales_tax_calculation\":\"string\",\"purchase_tax_calculation\":\"string\",\"postponed_accounting\":true,\"destination_vat\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/financial_settings", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"financial_settings\": {\n \"year_end_date\": \"2019-08-24\",\n \"year_end_lockdown_date\": \"2019-08-24\",\n \"accounting_type\": \"string\",\n \"accounts_start_date\": \"2019-08-24\",\n \"base_currency_id\": \"string\",\n \"multi_currency_enabled\": true,\n \"use_live_exchange_rates\": true,\n \"mtd_activation_status\": \"string\",\n \"mtd_connected\": true,\n \"mtd_authenticated_date\": \"2019-08-24\",\n \"tax_scheme_id\": \"string\",\n \"tax_return_frequency_id\": \"string\",\n \"tax_number\": \"string\",\n \"general_tax_number\": \"string\",\n \"tax_office_id\": \"string\",\n \"default_irpf_rate\": 0.1,\n \"flat_rate_tax_percentage\": 0.1,\n \"recoverable_percentage\": 0.1,\n \"sales_tax_calculation\": \"string\",\n \"purchase_tax_calculation\": \"string\",\n \"postponed_accounting\": true,\n \"destination_vat\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/financial_settings\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/financial_settings\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"financial_settings\\\":{\\\"year_end_date\\\":\\\"2019-08-24\\\",\\\"year_end_lockdown_date\\\":\\\"2019-08-24\\\",\\\"accounting_type\\\":\\\"string\\\",\\\"accounts_start_date\\\":\\\"2019-08-24\\\",\\\"base_currency_id\\\":\\\"string\\\",\\\"multi_currency_enabled\\\":true,\\\"use_live_exchange_rates\\\":true,\\\"mtd_activation_status\\\":\\\"string\\\",\\\"mtd_connected\\\":true,\\\"mtd_authenticated_date\\\":\\\"2019-08-24\\\",\\\"tax_scheme_id\\\":\\\"string\\\",\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"general_tax_number\\\":\\\"string\\\",\\\"tax_office_id\\\":\\\"string\\\",\\\"default_irpf_rate\\\":0.1,\\\"flat_rate_tax_percentage\\\":0.1,\\\"recoverable_percentage\\\":0.1,\\\"sales_tax_calculation\\\":\\\"string\\\",\\\"purchase_tax_calculation\\\":\\\"string\\\",\\\"postponed_accounting\\\":true,\\\"destination_vat\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/financial_settings\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n financial_settings: {\n year_end_date: '2019-08-24',\n year_end_lockdown_date: '2019-08-24',\n accounting_type: 'string',\n accounts_start_date: '2019-08-24',\n base_currency_id: 'string',\n multi_currency_enabled: true,\n use_live_exchange_rates: true,\n mtd_activation_status: 'string',\n mtd_connected: true,\n mtd_authenticated_date: '2019-08-24',\n tax_scheme_id: 'string',\n tax_return_frequency_id: 'string',\n tax_number: 'string',\n general_tax_number: 'string',\n tax_office_id: 'string',\n default_irpf_rate: 0.1,\n flat_rate_tax_percentage: 0.1,\n recoverable_percentage: 0.1,\n sales_tax_calculation: 'string',\n purchase_tax_calculation: 'string',\n postponed_accounting: true,\n destination_vat: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/financial_settings\"),\n Content = new StringContent(\"{\\\"financial_settings\\\":{\\\"year_end_date\\\":\\\"2019-08-24\\\",\\\"year_end_lockdown_date\\\":\\\"2019-08-24\\\",\\\"accounting_type\\\":\\\"string\\\",\\\"accounts_start_date\\\":\\\"2019-08-24\\\",\\\"base_currency_id\\\":\\\"string\\\",\\\"multi_currency_enabled\\\":true,\\\"use_live_exchange_rates\\\":true,\\\"mtd_activation_status\\\":\\\"string\\\",\\\"mtd_connected\\\":true,\\\"mtd_authenticated_date\\\":\\\"2019-08-24\\\",\\\"tax_scheme_id\\\":\\\"string\\\",\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"general_tax_number\\\":\\\"string\\\",\\\"tax_office_id\\\":\\\"string\\\",\\\"default_irpf_rate\\\":0.1,\\\"flat_rate_tax_percentage\\\":0.1,\\\"recoverable_percentage\\\":0.1,\\\"sales_tax_calculation\\\":\\\"string\\\",\\\"purchase_tax_calculation\\\":\\\"string\\\",\\\"postponed_accounting\\\":true,\\\"destination_vat\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/financial_settings\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"financial_settings\\\":{\\\"year_end_date\\\":\\\"2019-08-24\\\",\\\"year_end_lockdown_date\\\":\\\"2019-08-24\\\",\\\"accounting_type\\\":\\\"string\\\",\\\"accounts_start_date\\\":\\\"2019-08-24\\\",\\\"base_currency_id\\\":\\\"string\\\",\\\"multi_currency_enabled\\\":true,\\\"use_live_exchange_rates\\\":true,\\\"mtd_activation_status\\\":\\\"string\\\",\\\"mtd_connected\\\":true,\\\"mtd_authenticated_date\\\":\\\"2019-08-24\\\",\\\"tax_scheme_id\\\":\\\"string\\\",\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"general_tax_number\\\":\\\"string\\\",\\\"tax_office_id\\\":\\\"string\\\",\\\"default_irpf_rate\\\":0.1,\\\"flat_rate_tax_percentage\\\":0.1,\\\"recoverable_percentage\\\":0.1,\\\"sales_tax_calculation\\\":\\\"string\\\",\\\"purchase_tax_calculation\\\":\\\"string\\\",\\\"postponed_accounting\\\":true,\\\"destination_vat\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"financial_settings\\\":{\\\"year_end_date\\\":\\\"2019-08-24\\\",\\\"year_end_lockdown_date\\\":\\\"2019-08-24\\\",\\\"accounting_type\\\":\\\"string\\\",\\\"accounts_start_date\\\":\\\"2019-08-24\\\",\\\"base_currency_id\\\":\\\"string\\\",\\\"multi_currency_enabled\\\":true,\\\"use_live_exchange_rates\\\":true,\\\"mtd_activation_status\\\":\\\"string\\\",\\\"mtd_connected\\\":true,\\\"mtd_authenticated_date\\\":\\\"2019-08-24\\\",\\\"tax_scheme_id\\\":\\\"string\\\",\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"general_tax_number\\\":\\\"string\\\",\\\"tax_office_id\\\":\\\"string\\\",\\\"default_irpf_rate\\\":0.1,\\\"flat_rate_tax_percentage\\\":0.1,\\\"recoverable_percentage\\\":0.1,\\\"sales_tax_calculation\\\":\\\"string\\\",\\\"purchase_tax_calculation\\\":\\\"string\\\",\\\"postponed_accounting\\\":true,\\\"destination_vat\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/financial_settings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/financial_settings\"\n\npayload = {\"financial_settings\": {\n \"year_end_date\": \"2019-08-24\",\n \"year_end_lockdown_date\": \"2019-08-24\",\n \"accounting_type\": \"string\",\n \"accounts_start_date\": \"2019-08-24\",\n \"base_currency_id\": \"string\",\n \"multi_currency_enabled\": True,\n \"use_live_exchange_rates\": True,\n \"mtd_activation_status\": \"string\",\n \"mtd_connected\": True,\n \"mtd_authenticated_date\": \"2019-08-24\",\n \"tax_scheme_id\": \"string\",\n \"tax_return_frequency_id\": \"string\",\n \"tax_number\": \"string\",\n \"general_tax_number\": \"string\",\n \"tax_office_id\": \"string\",\n \"default_irpf_rate\": 0.1,\n \"flat_rate_tax_percentage\": 0.1,\n \"recoverable_percentage\": 0.1,\n \"sales_tax_calculation\": \"string\",\n \"purchase_tax_calculation\": \"string\",\n \"postponed_accounting\": True,\n \"destination_vat\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/income_tax_settings": { "get": { "summary": "Returns Income Tax Settings", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access, Read Only", "responses": { "200": { "description": "Returns all Income Tax Settings", "content": { "application/json": { "examples": { "response": { "value": { "$path": "/income_tax_settings", "income_tax_enabled": false, "income_tax_previously_enabled": false } } } } } } }, "tags": [ "Income Tax Settings" ], "operationId": "getIncomeTaxSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/income_tax_settings", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/income_tax_settings", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/income_tax_settings", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/income_tax_settings\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/income_tax_settings\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/income_tax_settings\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/income_tax_settings\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/income_tax_settings\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/income_tax_settings\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/income_tax_settings\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/invoice_settings": { "get": { "summary": "Returns all Invoice Settings", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access, Read Only", "responses": { "200": { "description": "Returns all Invoice Settings", "content": { "application/json": { "examples": { "response": { "value": { "$path": "/invoice_settings", "next_invoice_number": 376, "next_credit_note_number": 48, "separate_invoice_credit_note_numbering": true, "sales_invoice_number_prefix": "SI-", "sales_credit_note_number_prefix": "SCN-", "invoice_terms_and_conditions": "These are the terms & conditions created in document settings.", "default_note_on_invoice": "These are the notes set in the document settings", "default_note_on_credit_note": "", "default_note_on_estimate": "", "default_note_on_quote": "", "next_quote_number": 29, "quote_number_prefix": "SQ-", "estimate_number_prefix": "SE-", "quote_default_days_to_expiry": 30, "estimate_default_days_to_expiry": 30, "quote_terms_and_conditions": "These are the terms & conditions created in document settings.", "estimate_terms_and_conditions": "", "delivery_note_terms_and_conditions": "", "delivery_note_show_signature": false, "delivery_note_show_picked": false, "delivery_note_show_notes": false, "delivery_note_show_contact_details": false, "quick_entry_prefix": "QE-", "late_payment_percentage": null, "prompt_payment_percentage": null, "show_auto_entrepreneur": false, "show_insurance": false, "insurer": null, "insurance_area": null, "insurance_type": null, "insurance_text": null, "payment_bank_account": null, "sales_corrective_invoice_number_prefix": null, "next_sales_corrective_invoice_number": null, "document_headings": { "sales_invoice": "Sales Invoice", "sales_credit_note": "Sales Credit Note", "sales_corrective_invoice": null, "sales_quote": "Sales Quote", "sales_estimate": "Sales Estimate", "pro_forma": "Pro Forma Invoice", "remittance_advice": "Remittance Advice", "statement": "Statement", "delivery_note": "Delivery Note" }, "line_item_titles": { "description": "Description", "unit_price": "Price/Rate", "quantity": "Qty/Hrs", "discount": "Discount" }, "footer_details": { "column_1": "", "column_2": "", "column_3": "" }, "print_contact_details": { "business_name": true, "contact_name": true, "website": true, "telephone": true, "mobile": true, "email_address": true, "due_date": true, "default_delivery_address": "INVOICE_ADDRESS" }, "print_statements": { "days_overdue": true, "table_of_balances": true }, "customer_credit_days": 31, "vendor_credit_days": 30, "customer_credit_terms": "date_from_invoice", "vendor_credit_terms": "date_from_payment", "updated_at": "2024-10-18T01:09:36Z" } } } } } } }, "tags": [ "Invoice Settings" ], "operationId": "getInvoiceSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/invoice_settings", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/invoice_settings", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/invoice_settings", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/invoice_settings\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/invoice_settings\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/invoice_settings\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/invoice_settings\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/invoice_settings\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/invoice_settings\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/invoice_settings\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Invoice Settings", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putInvoiceSettings" }, "examples": { "Request example": { "value": { "invoice_settings": { "next_invoice_number": 1, "next_credit_note_number": 1, "separate_invoice_credit_note_numbering": true, "sales_invoice_number_prefix": "string", "sales_credit_note_number_prefix": "string", "invoice_terms_and_conditions": "string", "default_note_on_invoice": "string", "default_note_on_credit_note": "string", "default_note_on_estimate": "string", "default_note_on_quote": "string", "next_quote_number": 1, "quote_number_prefix": "string", "estimate_number_prefix": "string", "quote_default_days_to_expiry": 365, "estimate_default_days_to_expiry": 365, "quote_terms_and_conditions": "string", "estimate_terms_and_conditions": "string", "delivery_note_terms_and_conditions": "string", "delivery_note_show_signature": true, "delivery_note_show_picked": true, "delivery_note_show_notes": true, "delivery_note_show_contact_details": true, "quick_entry_prefix": "string", "late_payment_percentage": 0.1, "prompt_payment_percentage": 0.1, "show_auto_entrepreneur": true, "show_insurance": true, "insurer_id": "string", "insurance_area": "string", "insurance_type": "string", "insurance_text": "string", "payment_bank_account_id": "string", "sales_corrective_invoice_number_prefix": "string", "next_sales_corrective_invoice_number": 1, "customer_credit_days": 365, "vendor_credit_days": 365, "customer_credit_terms": "month_end_invoice", "vendor_credit_terms": "month_end_payment", "document_headings": { "sales_invoice": "string", "sales_credit_note": "string", "sales_corrective_invoice": "string", "sales_quote": "string", "sales_estimate": "string", "pro_forma": "string", "remittance_advice": "string", "statement": "string", "delivery_note": "string" }, "line_item_titles": { "description": "string", "unit_price": "string", "quantity": "string", "discount": "string" }, "footer_details": { "column_1": "string", "column_2": "string", "column_3": "string" }, "print_contact_details": { "business_name": true, "website": true, "telephone": true, "mobile": true, "email_address": true, "due_date": true, "default_delivery_address": "string" }, "print_statements": { "days_overdue": true, "table_of_balances": true } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Invoice Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceSettings" }, "examples": { "200 response example": { "value": { "$path": "string", "next_invoice_number": 0, "next_credit_note_number": 0, "separate_invoice_credit_note_numbering": true, "sales_invoice_number_prefix": "string", "sales_credit_note_number_prefix": "string", "invoice_terms_and_conditions": "string", "default_note_on_invoice": "string", "default_note_on_credit_note": "string", "default_note_on_estimate": "string", "default_note_on_quote": "string", "next_quote_number": 0, "quote_number_prefix": "string", "estimate_number_prefix": "string", "quote_default_days_to_expiry": 0, "estimate_default_days_to_expiry": 0, "quote_terms_and_conditions": "string", "estimate_terms_and_conditions": "string", "delivery_note_terms_and_conditions": "string", "delivery_note_show_signature": true, "delivery_note_show_picked": true, "delivery_note_show_notes": true, "delivery_note_show_contact_details": true, "quick_entry_prefix": "string", "late_payment_percentage": 0.1, "prompt_payment_percentage": 0.1, "show_auto_entrepreneur": true, "show_insurance": true, "insurer": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "type": "string" } ], "deleted_at": "2019-08-24T14:15:22Z", "balance": 0.1, "contact_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "reference": "string", "default_sales_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "default_sales_tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "default_purchase_ledger_account": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ledger_account_group": { "id": "string", "displayed_as": "string" }, "name": "string", "display_name": "string", "visible_scopes": [ "string" ], "included_in_chart": true, "nominal_code": 0, "ledger_account_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "ledger_account_classification": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_rate": { "id": "string", "displayed_as": "string", "$path": "string" }, "fixed_tax_rate": true, "visible_in_banking": true, "visible_in_expenses": true, "visible_in_journals": true, "visible_in_other_payments": true, "visible_in_other_receipts": true, "visible_in_reporting": true, "visible_in_sales": true, "balance_details": { "balance": 0.1, "credit_or_debit": "string", "credits": 0.1, "debits": 0.1, "from_date": "string", "to_date": "string" }, "is_control_account": true, "control_name": "string", "display_formatted": "string", "tax_recoverable": true, "recoverable_percentage": 0.1, "non_recoverable_ledger_account": {}, "cis_materials": true, "tax_instalment": true, "cis_labour": true, "gifi_code": 0 }, "tax_number": "string", "notes": "string", "locale": "string", "main_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "delivery_address": { "id": "string", "displayed_as": "string", "$path": "string", "address_line_1": "string", "address_line_2": "string", "city": "string", "postal_code": "string", "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "contact": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "name": "string", "region": "string", "country_group": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_main_address": true }, "main_contact_person": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "contact_person_types": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "name": "string", "job_title": "string", "telephone": "string", "mobile": "string", "email": "string", "fax": "string", "is_main_contact": true, "address": { "id": "string", "displayed_as": "string", "$path": "string" }, "is_preferred_contact": true }, "bank_account_details": { "account_name": "string", "account_number": "string", "sort_code": "string", "bic": "string", "iban": "string" }, "credit_limit": 0.1, "credit_days": 0, "credit_terms": "month_end_invoice", "credit_terms_and_conditions": "string", "product_sales_price_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "source_guid": "string", "currency": { "id": "string", "displayed_as": "string", "$path": "string" }, "aux_reference": "stri", "registered_number": "string", "deletable": true, "tax_treatment": { "home_tax": true, "eu_tax_registered": true, "eu_not_tax_registered": true, "rest_of_world_tax": true, "is_importer": true }, "email": "string", "tax_calculation": "string", "auxiliary_account": "string", "gdpr_obfuscated": true, "system": true, "has_unfinished_recurring_invoices": true, "cis_registered": true, "ni_based": true, "is_active": true, "gb_based": true, "cis_settings": { "registered_cis_name": "string", "subcontractor_verification_number": "string", "deduction_rate": { "id": "string", "displayed_as": "string", "$path": "string" } }, "destination_vat_blocking": true }, "insurance_area": "string", "insurance_type": "string", "insurance_text": "string", "payment_bank_account": { "id": "string", "displayed_as": "string", "$path": "string" }, "sales_corrective_invoice_number_prefix": "string", "next_sales_corrective_invoice_number": 0, "document_headings": { "sales_invoice": "string", "sales_credit_note": "string", "sales_corrective_invoice": "string", "sales_quote": "string", "sales_estimate": "string", "pro_forma": "string", "remittance_advice": "string", "statement": "string", "delivery_note": "string" }, "line_item_titles": { "description": "string", "unit_price": "string", "quantity": "string", "discount": "string" }, "footer_details": { "column_1": "string", "column_2": "string", "column_3": "string" }, "print_contact_details": { "business_name": true, "website": true, "telephone": true, "mobile": true, "email_address": true, "due_date": true, "default_delivery_address": "string" }, "print_statements": { "days_overdue": true, "table_of_balances": true }, "customer_credit_days": 0, "vendor_credit_days": 0, "customer_credit_terms": "month_end_invoice", "vendor_credit_terms": "month_end_payment", "updated_at": "2019-08-24T14:15:22Z" } } } } } } }, "tags": [ "Invoice Settings" ], "operationId": "putInvoiceSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/invoice_settings \\\n --header 'Content-Type: application/json' \\\n --data '{\"invoice_settings\":{\"next_invoice_number\":1,\"next_credit_note_number\":1,\"separate_invoice_credit_note_numbering\":true,\"sales_invoice_number_prefix\":\"string\",\"sales_credit_note_number_prefix\":\"string\",\"invoice_terms_and_conditions\":\"string\",\"default_note_on_invoice\":\"string\",\"default_note_on_credit_note\":\"string\",\"default_note_on_estimate\":\"string\",\"default_note_on_quote\":\"string\",\"next_quote_number\":1,\"quote_number_prefix\":\"string\",\"estimate_number_prefix\":\"string\",\"quote_default_days_to_expiry\":365,\"estimate_default_days_to_expiry\":365,\"quote_terms_and_conditions\":\"string\",\"estimate_terms_and_conditions\":\"string\",\"delivery_note_terms_and_conditions\":\"string\",\"delivery_note_show_signature\":true,\"delivery_note_show_picked\":true,\"delivery_note_show_notes\":true,\"delivery_note_show_contact_details\":true,\"quick_entry_prefix\":\"string\",\"late_payment_percentage\":0.1,\"prompt_payment_percentage\":0.1,\"show_auto_entrepreneur\":true,\"show_insurance\":true,\"insurer_id\":\"string\",\"insurance_area\":\"string\",\"insurance_type\":\"string\",\"insurance_text\":\"string\",\"payment_bank_account_id\":\"string\",\"sales_corrective_invoice_number_prefix\":\"string\",\"next_sales_corrective_invoice_number\":1,\"customer_credit_days\":365,\"vendor_credit_days\":365,\"customer_credit_terms\":\"month_end_invoice\",\"vendor_credit_terms\":\"month_end_payment\",\"document_headings\":{\"sales_invoice\":\"string\",\"sales_credit_note\":\"string\",\"sales_corrective_invoice\":\"string\",\"sales_quote\":\"string\",\"sales_estimate\":\"string\",\"pro_forma\":\"string\",\"remittance_advice\":\"string\",\"statement\":\"string\",\"delivery_note\":\"string\"},\"line_item_titles\":{\"description\":\"string\",\"unit_price\":\"string\",\"quantity\":\"string\",\"discount\":\"string\"},\"footer_details\":{\"column_1\":\"string\",\"column_2\":\"string\",\"column_3\":\"string\"},\"print_contact_details\":{\"business_name\":true,\"website\":true,\"telephone\":true,\"mobile\":true,\"email_address\":true,\"due_date\":true,\"default_delivery_address\":\"string\"},\"print_statements\":{\"days_overdue\":true,\"table_of_balances\":true}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"invoice_settings\":{\"next_invoice_number\":1,\"next_credit_note_number\":1,\"separate_invoice_credit_note_numbering\":true,\"sales_invoice_number_prefix\":\"string\",\"sales_credit_note_number_prefix\":\"string\",\"invoice_terms_and_conditions\":\"string\",\"default_note_on_invoice\":\"string\",\"default_note_on_credit_note\":\"string\",\"default_note_on_estimate\":\"string\",\"default_note_on_quote\":\"string\",\"next_quote_number\":1,\"quote_number_prefix\":\"string\",\"estimate_number_prefix\":\"string\",\"quote_default_days_to_expiry\":365,\"estimate_default_days_to_expiry\":365,\"quote_terms_and_conditions\":\"string\",\"estimate_terms_and_conditions\":\"string\",\"delivery_note_terms_and_conditions\":\"string\",\"delivery_note_show_signature\":true,\"delivery_note_show_picked\":true,\"delivery_note_show_notes\":true,\"delivery_note_show_contact_details\":true,\"quick_entry_prefix\":\"string\",\"late_payment_percentage\":0.1,\"prompt_payment_percentage\":0.1,\"show_auto_entrepreneur\":true,\"show_insurance\":true,\"insurer_id\":\"string\",\"insurance_area\":\"string\",\"insurance_type\":\"string\",\"insurance_text\":\"string\",\"payment_bank_account_id\":\"string\",\"sales_corrective_invoice_number_prefix\":\"string\",\"next_sales_corrective_invoice_number\":1,\"customer_credit_days\":365,\"vendor_credit_days\":365,\"customer_credit_terms\":\"month_end_invoice\",\"vendor_credit_terms\":\"month_end_payment\",\"document_headings\":{\"sales_invoice\":\"string\",\"sales_credit_note\":\"string\",\"sales_corrective_invoice\":\"string\",\"sales_quote\":\"string\",\"sales_estimate\":\"string\",\"pro_forma\":\"string\",\"remittance_advice\":\"string\",\"statement\":\"string\",\"delivery_note\":\"string\"},\"line_item_titles\":{\"description\":\"string\",\"unit_price\":\"string\",\"quantity\":\"string\",\"discount\":\"string\"},\"footer_details\":{\"column_1\":\"string\",\"column_2\":\"string\",\"column_3\":\"string\"},\"print_contact_details\":{\"business_name\":true,\"website\":true,\"telephone\":true,\"mobile\":true,\"email_address\":true,\"due_date\":true,\"default_delivery_address\":\"string\"},\"print_statements\":{\"days_overdue\":true,\"table_of_balances\":true}}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/invoice_settings \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"invoice_settings\":{\"next_invoice_number\":1,\"next_credit_note_number\":1,\"separate_invoice_credit_note_numbering\":true,\"sales_invoice_number_prefix\":\"string\",\"sales_credit_note_number_prefix\":\"string\",\"invoice_terms_and_conditions\":\"string\",\"default_note_on_invoice\":\"string\",\"default_note_on_credit_note\":\"string\",\"default_note_on_estimate\":\"string\",\"default_note_on_quote\":\"string\",\"next_quote_number\":1,\"quote_number_prefix\":\"string\",\"estimate_number_prefix\":\"string\",\"quote_default_days_to_expiry\":365,\"estimate_default_days_to_expiry\":365,\"quote_terms_and_conditions\":\"string\",\"estimate_terms_and_conditions\":\"string\",\"delivery_note_terms_and_conditions\":\"string\",\"delivery_note_show_signature\":true,\"delivery_note_show_picked\":true,\"delivery_note_show_notes\":true,\"delivery_note_show_contact_details\":true,\"quick_entry_prefix\":\"string\",\"late_payment_percentage\":0.1,\"prompt_payment_percentage\":0.1,\"show_auto_entrepreneur\":true,\"show_insurance\":true,\"insurer_id\":\"string\",\"insurance_area\":\"string\",\"insurance_type\":\"string\",\"insurance_text\":\"string\",\"payment_bank_account_id\":\"string\",\"sales_corrective_invoice_number_prefix\":\"string\",\"next_sales_corrective_invoice_number\":1,\"customer_credit_days\":365,\"vendor_credit_days\":365,\"customer_credit_terms\":\"month_end_invoice\",\"vendor_credit_terms\":\"month_end_payment\",\"document_headings\":{\"sales_invoice\":\"string\",\"sales_credit_note\":\"string\",\"sales_corrective_invoice\":\"string\",\"sales_quote\":\"string\",\"sales_estimate\":\"string\",\"pro_forma\":\"string\",\"remittance_advice\":\"string\",\"statement\":\"string\",\"delivery_note\":\"string\"},\"line_item_titles\":{\"description\":\"string\",\"unit_price\":\"string\",\"quantity\":\"string\",\"discount\":\"string\"},\"footer_details\":{\"column_1\":\"string\",\"column_2\":\"string\",\"column_3\":\"string\"},\"print_contact_details\":{\"business_name\":true,\"website\":true,\"telephone\":true,\"mobile\":true,\"email_address\":true,\"due_date\":true,\"default_delivery_address\":\"string\"},\"print_statements\":{\"days_overdue\":true,\"table_of_balances\":true}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/invoice_settings", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"invoice_settings\": {\n \"next_invoice_number\": 1,\n \"next_credit_note_number\": 1,\n \"separate_invoice_credit_note_numbering\": true,\n \"sales_invoice_number_prefix\": \"string\",\n \"sales_credit_note_number_prefix\": \"string\",\n \"invoice_terms_and_conditions\": \"string\",\n \"default_note_on_invoice\": \"string\",\n \"default_note_on_credit_note\": \"string\",\n \"default_note_on_estimate\": \"string\",\n \"default_note_on_quote\": \"string\",\n \"next_quote_number\": 1,\n \"quote_number_prefix\": \"string\",\n \"estimate_number_prefix\": \"string\",\n \"quote_default_days_to_expiry\": 365,\n \"estimate_default_days_to_expiry\": 365,\n \"quote_terms_and_conditions\": \"string\",\n \"estimate_terms_and_conditions\": \"string\",\n \"delivery_note_terms_and_conditions\": \"string\",\n \"delivery_note_show_signature\": true,\n \"delivery_note_show_picked\": true,\n \"delivery_note_show_notes\": true,\n \"delivery_note_show_contact_details\": true,\n \"quick_entry_prefix\": \"string\",\n \"late_payment_percentage\": 0.1,\n \"prompt_payment_percentage\": 0.1,\n \"show_auto_entrepreneur\": true,\n \"show_insurance\": true,\n \"insurer_id\": \"string\",\n \"insurance_area\": \"string\",\n \"insurance_type\": \"string\",\n \"insurance_text\": \"string\",\n \"payment_bank_account_id\": \"string\",\n \"sales_corrective_invoice_number_prefix\": \"string\",\n \"next_sales_corrective_invoice_number\": 1,\n \"customer_credit_days\": 365,\n \"vendor_credit_days\": 365,\n \"customer_credit_terms\": \"month_end_invoice\",\n \"vendor_credit_terms\": \"month_end_payment\",\n \"document_headings\": {\n \"sales_invoice\": \"string\",\n \"sales_credit_note\": \"string\",\n \"sales_corrective_invoice\": \"string\",\n \"sales_quote\": \"string\",\n \"sales_estimate\": \"string\",\n \"pro_forma\": \"string\",\n \"remittance_advice\": \"string\",\n \"statement\": \"string\",\n \"delivery_note\": \"string\"\n },\n \"line_item_titles\": {\n \"description\": \"string\",\n \"unit_price\": \"string\",\n \"quantity\": \"string\",\n \"discount\": \"string\"\n },\n \"footer_details\": {\n \"column_1\": \"string\",\n \"column_2\": \"string\",\n \"column_3\": \"string\"\n },\n \"print_contact_details\": {\n \"business_name\": true,\n \"website\": true,\n \"telephone\": true,\n \"mobile\": true,\n \"email_address\": true,\n \"due_date\": true,\n \"default_delivery_address\": \"string\"\n },\n \"print_statements\": {\n \"days_overdue\": true,\n \"table_of_balances\": true\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/invoice_settings\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/invoice_settings\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"invoice_settings\\\":{\\\"next_invoice_number\\\":1,\\\"next_credit_note_number\\\":1,\\\"separate_invoice_credit_note_numbering\\\":true,\\\"sales_invoice_number_prefix\\\":\\\"string\\\",\\\"sales_credit_note_number_prefix\\\":\\\"string\\\",\\\"invoice_terms_and_conditions\\\":\\\"string\\\",\\\"default_note_on_invoice\\\":\\\"string\\\",\\\"default_note_on_credit_note\\\":\\\"string\\\",\\\"default_note_on_estimate\\\":\\\"string\\\",\\\"default_note_on_quote\\\":\\\"string\\\",\\\"next_quote_number\\\":1,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"quote_default_days_to_expiry\\\":365,\\\"estimate_default_days_to_expiry\\\":365,\\\"quote_terms_and_conditions\\\":\\\"string\\\",\\\"estimate_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_show_signature\\\":true,\\\"delivery_note_show_picked\\\":true,\\\"delivery_note_show_notes\\\":true,\\\"delivery_note_show_contact_details\\\":true,\\\"quick_entry_prefix\\\":\\\"string\\\",\\\"late_payment_percentage\\\":0.1,\\\"prompt_payment_percentage\\\":0.1,\\\"show_auto_entrepreneur\\\":true,\\\"show_insurance\\\":true,\\\"insurer_id\\\":\\\"string\\\",\\\"insurance_area\\\":\\\"string\\\",\\\"insurance_type\\\":\\\"string\\\",\\\"insurance_text\\\":\\\"string\\\",\\\"payment_bank_account_id\\\":\\\"string\\\",\\\"sales_corrective_invoice_number_prefix\\\":\\\"string\\\",\\\"next_sales_corrective_invoice_number\\\":1,\\\"customer_credit_days\\\":365,\\\"vendor_credit_days\\\":365,\\\"customer_credit_terms\\\":\\\"month_end_invoice\\\",\\\"vendor_credit_terms\\\":\\\"month_end_payment\\\",\\\"document_headings\\\":{\\\"sales_invoice\\\":\\\"string\\\",\\\"sales_credit_note\\\":\\\"string\\\",\\\"sales_corrective_invoice\\\":\\\"string\\\",\\\"sales_quote\\\":\\\"string\\\",\\\"sales_estimate\\\":\\\"string\\\",\\\"pro_forma\\\":\\\"string\\\",\\\"remittance_advice\\\":\\\"string\\\",\\\"statement\\\":\\\"string\\\",\\\"delivery_note\\\":\\\"string\\\"},\\\"line_item_titles\\\":{\\\"description\\\":\\\"string\\\",\\\"unit_price\\\":\\\"string\\\",\\\"quantity\\\":\\\"string\\\",\\\"discount\\\":\\\"string\\\"},\\\"footer_details\\\":{\\\"column_1\\\":\\\"string\\\",\\\"column_2\\\":\\\"string\\\",\\\"column_3\\\":\\\"string\\\"},\\\"print_contact_details\\\":{\\\"business_name\\\":true,\\\"website\\\":true,\\\"telephone\\\":true,\\\"mobile\\\":true,\\\"email_address\\\":true,\\\"due_date\\\":true,\\\"default_delivery_address\\\":\\\"string\\\"},\\\"print_statements\\\":{\\\"days_overdue\\\":true,\\\"table_of_balances\\\":true}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/invoice_settings\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n invoice_settings: {\n next_invoice_number: 1,\n next_credit_note_number: 1,\n separate_invoice_credit_note_numbering: true,\n sales_invoice_number_prefix: 'string',\n sales_credit_note_number_prefix: 'string',\n invoice_terms_and_conditions: 'string',\n default_note_on_invoice: 'string',\n default_note_on_credit_note: 'string',\n default_note_on_estimate: 'string',\n default_note_on_quote: 'string',\n next_quote_number: 1,\n quote_number_prefix: 'string',\n estimate_number_prefix: 'string',\n quote_default_days_to_expiry: 365,\n estimate_default_days_to_expiry: 365,\n quote_terms_and_conditions: 'string',\n estimate_terms_and_conditions: 'string',\n delivery_note_terms_and_conditions: 'string',\n delivery_note_show_signature: true,\n delivery_note_show_picked: true,\n delivery_note_show_notes: true,\n delivery_note_show_contact_details: true,\n quick_entry_prefix: 'string',\n late_payment_percentage: 0.1,\n prompt_payment_percentage: 0.1,\n show_auto_entrepreneur: true,\n show_insurance: true,\n insurer_id: 'string',\n insurance_area: 'string',\n insurance_type: 'string',\n insurance_text: 'string',\n payment_bank_account_id: 'string',\n sales_corrective_invoice_number_prefix: 'string',\n next_sales_corrective_invoice_number: 1,\n customer_credit_days: 365,\n vendor_credit_days: 365,\n customer_credit_terms: 'month_end_invoice',\n vendor_credit_terms: 'month_end_payment',\n document_headings: {\n sales_invoice: 'string',\n sales_credit_note: 'string',\n sales_corrective_invoice: 'string',\n sales_quote: 'string',\n sales_estimate: 'string',\n pro_forma: 'string',\n remittance_advice: 'string',\n statement: 'string',\n delivery_note: 'string'\n },\n line_item_titles: {\n description: 'string',\n unit_price: 'string',\n quantity: 'string',\n discount: 'string'\n },\n footer_details: {column_1: 'string', column_2: 'string', column_3: 'string'},\n print_contact_details: {\n business_name: true,\n website: true,\n telephone: true,\n mobile: true,\n email_address: true,\n due_date: true,\n default_delivery_address: 'string'\n },\n print_statements: {days_overdue: true, table_of_balances: true}\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/invoice_settings\"),\n Content = new StringContent(\"{\\\"invoice_settings\\\":{\\\"next_invoice_number\\\":1,\\\"next_credit_note_number\\\":1,\\\"separate_invoice_credit_note_numbering\\\":true,\\\"sales_invoice_number_prefix\\\":\\\"string\\\",\\\"sales_credit_note_number_prefix\\\":\\\"string\\\",\\\"invoice_terms_and_conditions\\\":\\\"string\\\",\\\"default_note_on_invoice\\\":\\\"string\\\",\\\"default_note_on_credit_note\\\":\\\"string\\\",\\\"default_note_on_estimate\\\":\\\"string\\\",\\\"default_note_on_quote\\\":\\\"string\\\",\\\"next_quote_number\\\":1,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"quote_default_days_to_expiry\\\":365,\\\"estimate_default_days_to_expiry\\\":365,\\\"quote_terms_and_conditions\\\":\\\"string\\\",\\\"estimate_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_show_signature\\\":true,\\\"delivery_note_show_picked\\\":true,\\\"delivery_note_show_notes\\\":true,\\\"delivery_note_show_contact_details\\\":true,\\\"quick_entry_prefix\\\":\\\"string\\\",\\\"late_payment_percentage\\\":0.1,\\\"prompt_payment_percentage\\\":0.1,\\\"show_auto_entrepreneur\\\":true,\\\"show_insurance\\\":true,\\\"insurer_id\\\":\\\"string\\\",\\\"insurance_area\\\":\\\"string\\\",\\\"insurance_type\\\":\\\"string\\\",\\\"insurance_text\\\":\\\"string\\\",\\\"payment_bank_account_id\\\":\\\"string\\\",\\\"sales_corrective_invoice_number_prefix\\\":\\\"string\\\",\\\"next_sales_corrective_invoice_number\\\":1,\\\"customer_credit_days\\\":365,\\\"vendor_credit_days\\\":365,\\\"customer_credit_terms\\\":\\\"month_end_invoice\\\",\\\"vendor_credit_terms\\\":\\\"month_end_payment\\\",\\\"document_headings\\\":{\\\"sales_invoice\\\":\\\"string\\\",\\\"sales_credit_note\\\":\\\"string\\\",\\\"sales_corrective_invoice\\\":\\\"string\\\",\\\"sales_quote\\\":\\\"string\\\",\\\"sales_estimate\\\":\\\"string\\\",\\\"pro_forma\\\":\\\"string\\\",\\\"remittance_advice\\\":\\\"string\\\",\\\"statement\\\":\\\"string\\\",\\\"delivery_note\\\":\\\"string\\\"},\\\"line_item_titles\\\":{\\\"description\\\":\\\"string\\\",\\\"unit_price\\\":\\\"string\\\",\\\"quantity\\\":\\\"string\\\",\\\"discount\\\":\\\"string\\\"},\\\"footer_details\\\":{\\\"column_1\\\":\\\"string\\\",\\\"column_2\\\":\\\"string\\\",\\\"column_3\\\":\\\"string\\\"},\\\"print_contact_details\\\":{\\\"business_name\\\":true,\\\"website\\\":true,\\\"telephone\\\":true,\\\"mobile\\\":true,\\\"email_address\\\":true,\\\"due_date\\\":true,\\\"default_delivery_address\\\":\\\"string\\\"},\\\"print_statements\\\":{\\\"days_overdue\\\":true,\\\"table_of_balances\\\":true}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/invoice_settings\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"invoice_settings\\\":{\\\"next_invoice_number\\\":1,\\\"next_credit_note_number\\\":1,\\\"separate_invoice_credit_note_numbering\\\":true,\\\"sales_invoice_number_prefix\\\":\\\"string\\\",\\\"sales_credit_note_number_prefix\\\":\\\"string\\\",\\\"invoice_terms_and_conditions\\\":\\\"string\\\",\\\"default_note_on_invoice\\\":\\\"string\\\",\\\"default_note_on_credit_note\\\":\\\"string\\\",\\\"default_note_on_estimate\\\":\\\"string\\\",\\\"default_note_on_quote\\\":\\\"string\\\",\\\"next_quote_number\\\":1,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"quote_default_days_to_expiry\\\":365,\\\"estimate_default_days_to_expiry\\\":365,\\\"quote_terms_and_conditions\\\":\\\"string\\\",\\\"estimate_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_show_signature\\\":true,\\\"delivery_note_show_picked\\\":true,\\\"delivery_note_show_notes\\\":true,\\\"delivery_note_show_contact_details\\\":true,\\\"quick_entry_prefix\\\":\\\"string\\\",\\\"late_payment_percentage\\\":0.1,\\\"prompt_payment_percentage\\\":0.1,\\\"show_auto_entrepreneur\\\":true,\\\"show_insurance\\\":true,\\\"insurer_id\\\":\\\"string\\\",\\\"insurance_area\\\":\\\"string\\\",\\\"insurance_type\\\":\\\"string\\\",\\\"insurance_text\\\":\\\"string\\\",\\\"payment_bank_account_id\\\":\\\"string\\\",\\\"sales_corrective_invoice_number_prefix\\\":\\\"string\\\",\\\"next_sales_corrective_invoice_number\\\":1,\\\"customer_credit_days\\\":365,\\\"vendor_credit_days\\\":365,\\\"customer_credit_terms\\\":\\\"month_end_invoice\\\",\\\"vendor_credit_terms\\\":\\\"month_end_payment\\\",\\\"document_headings\\\":{\\\"sales_invoice\\\":\\\"string\\\",\\\"sales_credit_note\\\":\\\"string\\\",\\\"sales_corrective_invoice\\\":\\\"string\\\",\\\"sales_quote\\\":\\\"string\\\",\\\"sales_estimate\\\":\\\"string\\\",\\\"pro_forma\\\":\\\"string\\\",\\\"remittance_advice\\\":\\\"string\\\",\\\"statement\\\":\\\"string\\\",\\\"delivery_note\\\":\\\"string\\\"},\\\"line_item_titles\\\":{\\\"description\\\":\\\"string\\\",\\\"unit_price\\\":\\\"string\\\",\\\"quantity\\\":\\\"string\\\",\\\"discount\\\":\\\"string\\\"},\\\"footer_details\\\":{\\\"column_1\\\":\\\"string\\\",\\\"column_2\\\":\\\"string\\\",\\\"column_3\\\":\\\"string\\\"},\\\"print_contact_details\\\":{\\\"business_name\\\":true,\\\"website\\\":true,\\\"telephone\\\":true,\\\"mobile\\\":true,\\\"email_address\\\":true,\\\"due_date\\\":true,\\\"default_delivery_address\\\":\\\"string\\\"},\\\"print_statements\\\":{\\\"days_overdue\\\":true,\\\"table_of_balances\\\":true}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"invoice_settings\\\":{\\\"next_invoice_number\\\":1,\\\"next_credit_note_number\\\":1,\\\"separate_invoice_credit_note_numbering\\\":true,\\\"sales_invoice_number_prefix\\\":\\\"string\\\",\\\"sales_credit_note_number_prefix\\\":\\\"string\\\",\\\"invoice_terms_and_conditions\\\":\\\"string\\\",\\\"default_note_on_invoice\\\":\\\"string\\\",\\\"default_note_on_credit_note\\\":\\\"string\\\",\\\"default_note_on_estimate\\\":\\\"string\\\",\\\"default_note_on_quote\\\":\\\"string\\\",\\\"next_quote_number\\\":1,\\\"quote_number_prefix\\\":\\\"string\\\",\\\"estimate_number_prefix\\\":\\\"string\\\",\\\"quote_default_days_to_expiry\\\":365,\\\"estimate_default_days_to_expiry\\\":365,\\\"quote_terms_and_conditions\\\":\\\"string\\\",\\\"estimate_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_terms_and_conditions\\\":\\\"string\\\",\\\"delivery_note_show_signature\\\":true,\\\"delivery_note_show_picked\\\":true,\\\"delivery_note_show_notes\\\":true,\\\"delivery_note_show_contact_details\\\":true,\\\"quick_entry_prefix\\\":\\\"string\\\",\\\"late_payment_percentage\\\":0.1,\\\"prompt_payment_percentage\\\":0.1,\\\"show_auto_entrepreneur\\\":true,\\\"show_insurance\\\":true,\\\"insurer_id\\\":\\\"string\\\",\\\"insurance_area\\\":\\\"string\\\",\\\"insurance_type\\\":\\\"string\\\",\\\"insurance_text\\\":\\\"string\\\",\\\"payment_bank_account_id\\\":\\\"string\\\",\\\"sales_corrective_invoice_number_prefix\\\":\\\"string\\\",\\\"next_sales_corrective_invoice_number\\\":1,\\\"customer_credit_days\\\":365,\\\"vendor_credit_days\\\":365,\\\"customer_credit_terms\\\":\\\"month_end_invoice\\\",\\\"vendor_credit_terms\\\":\\\"month_end_payment\\\",\\\"document_headings\\\":{\\\"sales_invoice\\\":\\\"string\\\",\\\"sales_credit_note\\\":\\\"string\\\",\\\"sales_corrective_invoice\\\":\\\"string\\\",\\\"sales_quote\\\":\\\"string\\\",\\\"sales_estimate\\\":\\\"string\\\",\\\"pro_forma\\\":\\\"string\\\",\\\"remittance_advice\\\":\\\"string\\\",\\\"statement\\\":\\\"string\\\",\\\"delivery_note\\\":\\\"string\\\"},\\\"line_item_titles\\\":{\\\"description\\\":\\\"string\\\",\\\"unit_price\\\":\\\"string\\\",\\\"quantity\\\":\\\"string\\\",\\\"discount\\\":\\\"string\\\"},\\\"footer_details\\\":{\\\"column_1\\\":\\\"string\\\",\\\"column_2\\\":\\\"string\\\",\\\"column_3\\\":\\\"string\\\"},\\\"print_contact_details\\\":{\\\"business_name\\\":true,\\\"website\\\":true,\\\"telephone\\\":true,\\\"mobile\\\":true,\\\"email_address\\\":true,\\\"due_date\\\":true,\\\"default_delivery_address\\\":\\\"string\\\"},\\\"print_statements\\\":{\\\"days_overdue\\\":true,\\\"table_of_balances\\\":true}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/invoice_settings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/invoice_settings\"\n\npayload = {\"invoice_settings\": {\n \"next_invoice_number\": 1,\n \"next_credit_note_number\": 1,\n \"separate_invoice_credit_note_numbering\": True,\n \"sales_invoice_number_prefix\": \"string\",\n \"sales_credit_note_number_prefix\": \"string\",\n \"invoice_terms_and_conditions\": \"string\",\n \"default_note_on_invoice\": \"string\",\n \"default_note_on_credit_note\": \"string\",\n \"default_note_on_estimate\": \"string\",\n \"default_note_on_quote\": \"string\",\n \"next_quote_number\": 1,\n \"quote_number_prefix\": \"string\",\n \"estimate_number_prefix\": \"string\",\n \"quote_default_days_to_expiry\": 365,\n \"estimate_default_days_to_expiry\": 365,\n \"quote_terms_and_conditions\": \"string\",\n \"estimate_terms_and_conditions\": \"string\",\n \"delivery_note_terms_and_conditions\": \"string\",\n \"delivery_note_show_signature\": True,\n \"delivery_note_show_picked\": True,\n \"delivery_note_show_notes\": True,\n \"delivery_note_show_contact_details\": True,\n \"quick_entry_prefix\": \"string\",\n \"late_payment_percentage\": 0.1,\n \"prompt_payment_percentage\": 0.1,\n \"show_auto_entrepreneur\": True,\n \"show_insurance\": True,\n \"insurer_id\": \"string\",\n \"insurance_area\": \"string\",\n \"insurance_type\": \"string\",\n \"insurance_text\": \"string\",\n \"payment_bank_account_id\": \"string\",\n \"sales_corrective_invoice_number_prefix\": \"string\",\n \"next_sales_corrective_invoice_number\": 1,\n \"customer_credit_days\": 365,\n \"vendor_credit_days\": 365,\n \"customer_credit_terms\": \"month_end_invoice\",\n \"vendor_credit_terms\": \"month_end_payment\",\n \"document_headings\": {\n \"sales_invoice\": \"string\",\n \"sales_credit_note\": \"string\",\n \"sales_corrective_invoice\": \"string\",\n \"sales_quote\": \"string\",\n \"sales_estimate\": \"string\",\n \"pro_forma\": \"string\",\n \"remittance_advice\": \"string\",\n \"statement\": \"string\",\n \"delivery_note\": \"string\"\n },\n \"line_item_titles\": {\n \"description\": \"string\",\n \"unit_price\": \"string\",\n \"quantity\": \"string\",\n \"discount\": \"string\"\n },\n \"footer_details\": {\n \"column_1\": \"string\",\n \"column_2\": \"string\",\n \"column_3\": \"string\"\n },\n \"print_contact_details\": {\n \"business_name\": True,\n \"website\": True,\n \"telephone\": True,\n \"mobile\": True,\n \"email_address\": True,\n \"due_date\": True,\n \"default_delivery_address\": \"string\"\n },\n \"print_statements\": {\n \"days_overdue\": True,\n \"table_of_balances\": True\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/legal_form_types": { "get": { "summary": "Returns all Legal Form Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Business Classifications per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Business Classifications", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Business Classifications (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Legal Form Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegalFormType" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Legal Form Types" ], "operationId": "getLegalFormTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/legal_form_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/legal_form_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/legal_form_types/{key}": { "get": { "summary": "Returns a Legal Form Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท", "parameters": [ { "in": "path", "name": "key", "description": "The Legal Form Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Business Classification (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Legal Form Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalFormType" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Legal Form Types" ], "operationId": "getLegalFormTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/legal_form_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/legal_form_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/countries_of_registration": { "get": { "summary": "Returns all Country Of Registrations", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Registered Countries per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Registered Countries", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Registered Countries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Country Of Registrations", "content": { "application/json": { "examples": { "response": { "value": { "$total": 5, "$page": 1, "$next": null, "$back": null, "$itemsPerPage": 20, "$items": [ { "id": "ENGLAND_AND_WALES", "displayed_as": "England and Wales", "$path": "/countries_of_registration/ENGLAND_AND_WALES" }, { "id": "WALES", "displayed_as": "Wales", "$path": "/countries_of_registration/WALES" }, { "id": "SCOTLAND", "displayed_as": "Scotland", "$path": "/countries_of_registration/SCOTLAND" }, { "id": "NORTHERN_IRELAND", "displayed_as": "Northern Ireland", "$path": "/countries_of_registration/NORTHERN_IRELAND" }, { "id": "REPUBLIC_OF_IRELAND", "displayed_as": "Republic of Ireland", "$path": "/countries_of_registration/REPUBLIC_OF_IRELAND" } ] } } } } } } }, "tags": [ "Country Of Registrations" ], "operationId": "getCountriesOfRegistration", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/countries_of_registration?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/countries_of_registration\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/countries_of_registration/{key}": { "get": { "summary": "Returns a Country Of Registration", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Country Of Registration Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Registered Country (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Country Of Registration", "content": { "application/json": { "examples": { "response": { "value": { "id": "ENGLAND_AND_WALES", "displayed_as": "England and Wales", "$path": "/countries_of_registration/ENGLAND_AND_WALES" } } } } } } }, "tags": [ "Country Of Registrations" ], "operationId": "getCountriesOfRegistrationKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/countries_of_registration/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/countries_of_registration/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/draft_tax_returns": { "get": { "summary": "Returns all Draft Tax Returns", "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 `Statutory reporting`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Returns per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Returns", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Returns (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Draft Tax Returns", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DraftTaxReturn" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_return_number": "stri", "period_start_date": "2019-08-24", "period_end_date": "2019-08-24", "total_amount": 0.1, "paid": true, "status": { "id": "string", "name": "string" }, "tax_return_type": { "id": "string", "name": "string" }, "tax_return_id": 0, "submitted_date": "2019-08-24" } ] } } } } } }, "tags": [ "Draft Tax Returns" ], "operationId": "getDraftTaxReturns", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/draft_tax_returns?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/draft_tax_returns\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Statutory reporting`: Full Access", "summary": "Create a Draft Tax Return", "parameters": [ { "in": "header", "name": "X-Idempotency-Key", "description": "Require idempotency key to be passed in the request header.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "description": "Return the Created Draft Tax Return", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftTaxReturn" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_return_number": "stri", "period_start_date": "2019-08-24", "period_end_date": "2019-08-24", "total_amount": 0.1, "paid": true, "status": { "id": "string", "name": "string" }, "tax_return_type": { "id": "string", "name": "string" }, "tax_return_id": 0, "submitted_date": "2019-08-24" } } } } } }, "202": { "description": "The Obligation Period is not yet available" } }, "tags": [ "Draft Tax Returns" ], "operationId": "postDraftTaxReturns", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/draft_tax_returns \\\n --header 'X-Idempotency-Key: SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http POST https://api.accounting.sage.com/v3.1/draft_tax_returns \\\n X-Idempotency-Key:SOME_STRING_VALUE", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'X-Idempotency-Key: SOME_STRING_VALUE' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/draft_tax_returns", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/draft_tax_returns\");\nxhr.setRequestHeader(\"X-Idempotency-Key\", \"SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/draft_tax_returns\",\n \"method\": \"POST\",\n \"headers\": {\n \"X-Idempotency-Key\": \"SOME_STRING_VALUE\"\n }\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/draft_tax_returns\",\n \"headers\": {\n \"X-Idempotency-Key\": \"SOME_STRING_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/draft_tax_returns\"),\n Headers =\n {\n { \"X-Idempotency-Key\", \"SOME_STRING_VALUE\" },\n },\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/draft_tax_returns\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"X-Idempotency-Key\", \"SOME_STRING_VALUE\");\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nheaders = { 'X-Idempotency-Key': \"SOME_STRING_VALUE\" }\n\nconn.request(\"POST\", \"/v3.1/draft_tax_returns\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/draft_tax_returns\"\n\nheaders = {\"X-Idempotency-Key\": \"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"POST\", url, headers=headers)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/draft_tax_returns/{key}": { "get": { "summary": "Returns a Draft Tax Return", "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 `Statutory reporting`: Read Only, Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Draft Tax Return Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Return (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Draft Tax Return", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftTaxReturn" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_return_number": "stri", "period_start_date": "2019-08-24", "period_end_date": "2019-08-24", "total_amount": 0.1, "paid": true, "status": { "id": "string", "name": "string" }, "tax_return_type": { "id": "string", "name": "string" }, "tax_return_id": 0, "submitted_date": "2019-08-24" } } } } } } }, "tags": [ "Draft Tax Returns" ], "operationId": "getDraftTaxReturnsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/draft_tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Draft Tax Return", "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 `Statutory reporting`: Restricted Access, Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Draft Tax Return Key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Draft Tax Return" } }, "tags": [ "Draft Tax Returns" ], "operationId": "deleteDraftTaxReturnsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/draft_tax_returns/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/draft_tax_returns/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/draft_tax_returns/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_determinations": { "get": { "summary": "Returns all Tax Determinations", "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 `Settings`: Full Access", "parameters": [ { "in": "query", "name": "artefact_id", "description": "The artefact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "artefact_line_amount", "description": "The artefact line amount", "required": false, "schema": { "type": "number", "format": "double" } }, { "in": "query", "name": "artefact_line_description", "description": "The artefact line description", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "artefact_line_goods_services_type", "description": "The artefact line goods and service type", "required": false, "example": "GOODS", "schema": { "type": "string", "enum": [ "GOODS", "SERVICES" ] } }, { "in": "query", "name": "artefact_line_id", "description": "The artefact line id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "artefact_line_tax_included", "description": "The artefact line includes tax", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "contact_id", "description": "Use this to filter by contact id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "date", "description": "Use this to return results on a specified date.", "required": false, "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "include_destination_vat", "description": "Include destination vat", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "include_line_determination", "description": "Include line determination", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "retailer_rates", "description": "Display recargo retailer rates", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "usage", "description": "Tax rates with the intended usage", "required": true, "example": "possible values are sales and purchases", "schema": { "type": "string", "enum": [ "sales", "purchases" ] } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Rates per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Rates", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Determinations", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] } ] } } } } } }, "tags": [ "Tax Determinations" ], "operationId": "getTaxDeterminations", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_determinations?artefact_id=SOME_STRING_VALUE&artefact_line_amount=SOME_NUMBER_VALUE&artefact_line_description=SOME_STRING_VALUE&artefact_line_goods_services_type=GOODS&artefact_line_id=SOME_STRING_VALUE&artefact_line_tax_included=SOME_STRING_VALUE&contact_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_destination_vat=SOME_BOOLEAN_VALUE&include_line_determination=SOME_BOOLEAN_VALUE&retailer_rates=SOME_BOOLEAN_VALUE&usage=possible%20values%20are%20sales%20and%20purchases&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_determinations\"\n\nquerystring = {\"artefact_id\":\"SOME_STRING_VALUE\",\"artefact_line_amount\":\"SOME_NUMBER_VALUE\",\"artefact_line_description\":\"SOME_STRING_VALUE\",\"artefact_line_goods_services_type\":\"GOODS\",\"artefact_line_id\":\"SOME_STRING_VALUE\",\"artefact_line_tax_included\":\"SOME_STRING_VALUE\",\"contact_id\":\"SOME_STRING_VALUE\",\"date\":\"SOME_STRING_VALUE\",\"include_destination_vat\":\"SOME_BOOLEAN_VALUE\",\"include_line_determination\":\"SOME_BOOLEAN_VALUE\",\"retailer_rates\":\"SOME_BOOLEAN_VALUE\",\"usage\":\"possible values are sales and purchases\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_offices": { "get": { "summary": "Returns all Tax Offices", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ฉ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฉ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡ฉ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Offices per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Offices", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Offices (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Offices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxOffice" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "office_number": "stri", "name": "string" } ] } } } } } }, "tags": [ "Tax Offices" ], "operationId": "getTaxOffices", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_offices?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_offices\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_offices/{key}": { "get": { "summary": "Returns a Tax Office", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ฉ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฉ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡ฉ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Office Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Office (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Tax Office", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxOffice" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "office_number": "stri", "name": "string" } } } } } } }, "tags": [ "Tax Offices" ], "operationId": "getTaxOfficesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_offices/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_offices/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_profiles": { "get": { "summary": "Returns all Tax Profiles", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Tax Profiles 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Profiles per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Profiles", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Profiles (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Profiles", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProfile" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_number": "string", "tax_number_suffix": "string", "collect_tax": true, "tax_return_frequency": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_region": { "id": "string", "displayed_as": "string", "$path": "string", "code": "string", "name": "string" } } ] } } } } } }, "tags": [ "Tax Profiles" ], "operationId": "getTaxProfiles", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_profiles?updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_profiles\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_profiles/{key}": { "get": { "summary": "Returns a Tax Profile", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Profile Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Profile (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Tax Profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxProfile" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_number": "string", "tax_number_suffix": "string", "collect_tax": true, "tax_return_frequency": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_region": { "id": "string", "displayed_as": "string", "$path": "string", "code": "string", "name": "string" } } } } } } } }, "tags": [ "Tax Profiles" ], "operationId": "getTaxProfilesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_profiles/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Tax Profile", "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Profile Key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putTaxProfiles" }, "examples": { "Request example": { "value": { "tax_profile": { "tax_type_id": "string", "tax_number": "string", "tax_number_suffix": "string", "collect_tax": true, "tax_return_frequency_id": "string", "address_region": { "name": "string", "code": "string" } } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Tax Profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxProfile" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_type": { "id": "string", "displayed_as": "string", "$path": "string" }, "tax_number": "string", "tax_number_suffix": "string", "collect_tax": true, "tax_return_frequency": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_region": { "id": "string", "displayed_as": "string", "$path": "string", "code": "string", "name": "string" } } } } } } } }, "tags": [ "Tax Profiles" ], "operationId": "putTaxProfilesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"tax_profile\":{\"tax_type_id\":\"string\",\"tax_number\":\"string\",\"tax_number_suffix\":\"string\",\"collect_tax\":true,\"tax_return_frequency_id\":\"string\",\"address_region\":{\"name\":\"string\",\"code\":\"string\"}}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"tax_profile\":{\"tax_type_id\":\"string\",\"tax_number\":\"string\",\"tax_number_suffix\":\"string\",\"collect_tax\":true,\"tax_return_frequency_id\":\"string\",\"address_region\":{\"name\":\"string\",\"code\":\"string\"}}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"tax_profile\":{\"tax_type_id\":\"string\",\"tax_number\":\"string\",\"tax_number_suffix\":\"string\",\"collect_tax\":true,\"tax_return_frequency_id\":\"string\",\"address_region\":{\"name\":\"string\",\"code\":\"string\"}}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"tax_profile\": {\n \"tax_type_id\": \"string\",\n \"tax_number\": \"string\",\n \"tax_number_suffix\": \"string\",\n \"collect_tax\": true,\n \"tax_return_frequency_id\": \"string\",\n \"address_region\": {\n \"name\": \"string\",\n \"code\": \"string\"\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"tax_profile\\\":{\\\"tax_type_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"tax_number_suffix\\\":\\\"string\\\",\\\"collect_tax\\\":true,\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"address_region\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\"}}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_profiles/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n tax_profile: {\n tax_type_id: 'string',\n tax_number: 'string',\n tax_number_suffix: 'string',\n collect_tax: true,\n tax_return_frequency_id: 'string',\n address_region: {name: 'string', code: 'string'}\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"tax_profile\\\":{\\\"tax_type_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"tax_number_suffix\\\":\\\"string\\\",\\\"collect_tax\\\":true,\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"address_region\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\"}}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"tax_profile\\\":{\\\"tax_type_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"tax_number_suffix\\\":\\\"string\\\",\\\"collect_tax\\\":true,\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"address_region\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\"}}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"tax_profile\\\":{\\\"tax_type_id\\\":\\\"string\\\",\\\"tax_number\\\":\\\"string\\\",\\\"tax_number_suffix\\\":\\\"string\\\",\\\"collect_tax\\\":true,\\\"tax_return_frequency_id\\\":\\\"string\\\",\\\"address_region\\\":{\\\"name\\\":\\\"string\\\",\\\"code\\\":\\\"string\\\"}}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/tax_profiles/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_profiles/%7Bkey%7D\"\n\npayload = {\"tax_profile\": {\n \"tax_type_id\": \"string\",\n \"tax_number\": \"string\",\n \"tax_number_suffix\": \"string\",\n \"collect_tax\": True,\n \"tax_return_frequency_id\": \"string\",\n \"address_region\": {\n \"name\": \"string\",\n \"code\": \"string\"\n }\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/tax_rates": { "get": { "summary": "Returns all Tax Rates", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Full Access, Restricted Access, Read Only\n* Area: `Purchases`: Full Access, Restricted Access, Read Only\n* Area: `Bank`: Full Access, Restricted Access, Read Only\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Tax Rates changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "usage", "description": "possible values are `sales` and `purchase`", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "address_region_id", "description": "Use this to filter by address region id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "date", "description": "Use this to return results on a specified date.", "required": false, "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "include_historical_data", "description": "Use this to include historical data in the response", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "include_destination_vat_rates", "description": "Include vat destination tax rates", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "cis_only", "description": "Use this to filter Tax Rates to CIS only records", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Rates per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Rates", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Rates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] } ] } } } } } }, "tags": [ "Tax Rates" ], "operationId": "getTaxRates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_rates?updated_or_created_since=2015-10-27T16%3A24%3A52Z&usage=SOME_STRING_VALUE&address_region_id=SOME_STRING_VALUE&date=SOME_STRING_VALUE&include_historical_data=SOME_BOOLEAN_VALUE&include_destination_vat_rates=SOME_BOOLEAN_VALUE&cis_only=SOME_BOOLEAN_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_rates\"\n\nquerystring = {\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"usage\":\"SOME_STRING_VALUE\",\"address_region_id\":\"SOME_STRING_VALUE\",\"date\":\"SOME_STRING_VALUE\",\"include_historical_data\":\"SOME_BOOLEAN_VALUE\",\"include_destination_vat_rates\":\"SOME_BOOLEAN_VALUE\",\"cis_only\":\"SOME_BOOLEAN_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "post": { "summary": "Creates a Tax Rate (US only)", "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postTaxRates" }, "examples": { "Request example": { "value": { "tax_rate": { "name": "string", "agency": "string", "is_visible": true, "component_tax_rate": [ { "name": "string", "agency": "string", "percentage": 0.1 } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "201": { "description": "Creates a Tax Rate (US only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" }, "examples": { "201 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] } } } } } } }, "tags": [ "Tax Rates" ], "operationId": "postTaxRates", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/tax_rates \\\n --header 'Content-Type: application/json' \\\n --data '{\"tax_rate\":{\"name\":\"string\",\"agency\":\"string\",\"is_visible\":true,\"component_tax_rate\":[{\"name\":\"string\",\"agency\":\"string\",\"percentage\":0.1}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"tax_rate\":{\"name\":\"string\",\"agency\":\"string\",\"is_visible\":true,\"component_tax_rate\":[{\"name\":\"string\",\"agency\":\"string\",\"percentage\":0.1}]}}' | \\\n http POST https://api.accounting.sage.com/v3.1/tax_rates \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"tax_rate\":{\"name\":\"string\",\"agency\":\"string\",\"is_visible\":true,\"component_tax_rate\":[{\"name\":\"string\",\"agency\":\"string\",\"percentage\":0.1}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/tax_rates", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"tax_rate\": {\n \"name\": \"string\",\n \"agency\": \"string\",\n \"is_visible\": true,\n \"component_tax_rate\": [\n {\n \"name\": \"string\",\n \"agency\": \"string\",\n \"percentage\": 0.1\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/tax_rates\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_rates\",\n \"method\": \"POST\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"is_visible\\\":true,\\\"component_tax_rate\\\":[{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_rates\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n tax_rate: {\n name: 'string',\n agency: 'string',\n is_visible: true,\n component_tax_rate: [{name: 'string', agency: 'string', percentage: 0.1}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_rates\"),\n Content = new StringContent(\"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"is_visible\\\":true,\\\"component_tax_rate\\\":[{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_rates\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"is_visible\\\":true,\\\"component_tax_rate\\\":[{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"is_visible\\\":true,\\\"component_tax_rate\\\":[{\\\"name\\\":\\\"string\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"POST\", \"/v3.1/tax_rates\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_rates\"\n\npayload = {\"tax_rate\": {\n \"name\": \"string\",\n \"agency\": \"string\",\n \"is_visible\": True,\n \"component_tax_rate\": [\n {\n \"name\": \"string\",\n \"agency\": \"string\",\n \"percentage\": 0.1\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } }, "/tax_rates/{key}": { "get": { "summary": "Returns a Tax Rate", "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Full Access, Restricted Access, Read Only\n* Area: `Purchases`: Full Access, Restricted Access, Read Only\n* Area: `Bank`: Full Access, Restricted Access, Read Only\n* Area: `Settings`: Full Access, Read Only", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Rate Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "date", "description": "Use this to show the tax rate percentage on the given date", "required": false, "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Rate (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Tax Rate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] } } } } } } }, "tags": [ "Tax Rates" ], "operationId": "getTaxRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_rates/%7Bkey%7D?date=SOME_STRING_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\"\n\nquerystring = {\"date\":\"SOME_STRING_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Tax Rate (US only)", "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Rate key.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putTaxRates" }, "examples": { "Request example": { "value": { "tax_rate": { "name": "string", "from_date": "2019-08-24T14:15:22Z", "agency": "string", "percentage": 0.1, "is_visible": true } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Tax Rate (US only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true, "component_tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "agency": "string", "percentage": 0.1, "percentages": [ { "percentage": 0.1, "from_date": "2019-08-24", "to_date": "2019-08-24" } ], "is_visible": true, "retailer": true, "editable": true, "deletable": true, "is_combined_rate": true } ] } } } } } } }, "tags": [ "Tax Rates" ], "operationId": "putTaxRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D \\\n --header 'Content-Type: application/json' \\\n --data '{\"tax_rate\":{\"name\":\"string\",\"from_date\":\"2019-08-24T14:15:22Z\",\"agency\":\"string\",\"percentage\":0.1,\"is_visible\":true}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"tax_rate\":{\"name\":\"string\",\"from_date\":\"2019-08-24T14:15:22Z\",\"agency\":\"string\",\"percentage\":0.1,\"is_visible\":true}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"tax_rate\":{\"name\":\"string\",\"from_date\":\"2019-08-24T14:15:22Z\",\"agency\":\"string\",\"percentage\":0.1,\"is_visible\":true}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"tax_rate\": {\n \"name\": \"string\",\n \"from_date\": \"2019-08-24T14:15:22Z\",\n \"agency\": \"string\",\n \"percentage\": 0.1,\n \"is_visible\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"from_date\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1,\\\"is_visible\\\":true}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_rates/%7Bkey%7D\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n tax_rate: {\n name: 'string',\n from_date: '2019-08-24T14:15:22Z',\n agency: 'string',\n percentage: 0.1,\n is_visible: true\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\"),\n Content = new StringContent(\"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"from_date\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1,\\\"is_visible\\\":true}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"from_date\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1,\\\"is_visible\\\":true}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"tax_rate\\\":{\\\"name\\\":\\\"string\\\",\\\"from_date\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"agency\\\":\\\"string\\\",\\\"percentage\\\":0.1,\\\"is_visible\\\":true}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/tax_rates/%7Bkey%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\"\n\npayload = {\"tax_rate\": {\n \"name\": \"string\",\n \"from_date\": \"2019-08-24T14:15:22Z\",\n \"agency\": \"string\",\n \"percentage\": 0.1,\n \"is_visible\": True\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] }, "delete": { "summary": "Deletes a Tax Rate (US only)", "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Rate key.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes a Tax Rate (US only)" } }, "tags": [ "Tax Rates" ], "operationId": "deleteTaxRatesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request DELETE \\\n --url https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http DELETE https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method DELETE \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\",\n \"method\": \"DELETE\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_rates/%7Bkey%7D\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Delete,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\");\nvar request = new RestRequest(Method.DELETE);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"DELETE\", \"/v3.1/tax_rates/%7Bkey%7D\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_rates/%7Bkey%7D\"\n\nresponse = requests.request(\"DELETE\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_return_frequencies": { "get": { "summary": "Returns all Tax Return Frequencies", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Standard: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ", "parameters": [ { "in": "query", "name": "tax_type_id", "description": "Use this to filter Tax Submission Frequency Types by tax_type_id (Canada only)", "required": false, "schema": { "type": "string", "enum": [ "CA_GST_HST", "CA_PST_BC", "CA_PST_MB", "CA_QST", "CA_PST_SK" ] } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Submission Frequency Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Submission Frequency Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Submission Frequency Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Return Frequencies", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Tax Return Frequencies" ], "operationId": "getTaxReturnFrequencies", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_return_frequencies?tax_type_id=SOME_STRING_VALUE&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_return_frequencies\"\n\nquerystring = {\"tax_type_id\":\"SOME_STRING_VALUE\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_return_frequencies/{key}": { "get": { "summary": "Returns a Tax Return Frequency", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Standard: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Return Frequency Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Submission Frequency Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Tax Return Frequency", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Tax Return Frequencies" ], "operationId": "getTaxReturnFrequenciesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_return_frequencies/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_return_frequencies/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_schemes": { "get": { "summary": "Returns all Tax Schemes", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Schemes per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Schemes", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Schemes (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Schemes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxScheme" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } }, "tags": [ "Tax Schemes" ], "operationId": "getTaxSchemes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_schemes?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_schemes\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_schemes/{key}": { "get": { "summary": "Returns a Tax Scheme", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Scheme Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Scheme (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Tax Scheme", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxScheme" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string" } } } } } } }, "tags": [ "Tax Schemes" ], "operationId": "getTaxSchemesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_schemes/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_schemes/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_returns": { "get": { "summary": "Returns all Tax Returns", "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 `Statutory reporting`: Full Access", "parameters": [ { "in": "query", "name": "from_period_start_date", "description": "Use this to filter tax returns by the tax return period start date", "required": false, "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "to_period_start_date", "description": "Use this to filter tax returns by the tax return period start date", "required": false, "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "updated_or_created_since", "description": "Use this to limit the response to Tax Returns 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.", "required": false, "example": "2015-10-27T16:24:52Z", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Returns per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Returns", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Returns (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Returns", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxReturn" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_return_number": "stri", "period_start_date": "2019-08-24", "period_end_date": "2019-08-24", "total_amount": 0.1, "paid": true, "status": { "id": "string", "name": "string" }, "tax_return_type": { "id": "string", "name": "string" } } ] } } } } } }, "tags": [ "Tax Returns" ], "operationId": "getTaxReturns", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_returns?from_period_start_date=SOME_STRING_VALUE&to_period_start_date=SOME_STRING_VALUE&updated_or_created_since=2015-10-27T16%3A24%3A52Z&items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_returns\"\n\nquerystring = {\"from_period_start_date\":\"SOME_STRING_VALUE\",\"to_period_start_date\":\"SOME_STRING_VALUE\",\"updated_or_created_since\":\"2015-10-27T16:24:52Z\",\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_returns/{key}": { "get": { "summary": "Returns a Tax Return", "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 `Statutory reporting`: Full Access", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Return Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Return (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Tax Return", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxReturn" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "tax_return_number": "stri", "period_start_date": "2019-08-24", "period_end_date": "2019-08-24", "total_amount": 0.1, "paid": true, "status": { "id": "string", "name": "string" }, "tax_return_type": { "id": "string", "name": "string" } } } } } } } }, "tags": [ "Tax Returns" ], "operationId": "getTaxReturnsKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_returns/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_returns/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_returns/obligation_periods": { "post": { "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Statutory reporting`: Full Access", "summary": "Returns a Tax Return of the Obligation Period", "parameters": [ { "in": "header", "name": "X-Idempotency-Key", "description": "Require idempotency key to be passed in the request header.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "description": "Create an Obligation Period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MtdObligationPeriod" }, "examples": { "201 response example": { "value": { "start_date": "2019-08-24", "end_date": "2019-08-24", "due_date": "2019-08-24", "received_date": "2019-08-24", "hmrc_status": "string", "period_key": "string", "status": "string" } } } } } }, "202": { "description": "The Obligation Period is not yet available" } }, "tags": [ "Tax Returns" ], "operationId": "postTaxReturnsObligationPeriods", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request POST \\\n --url https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods \\\n --header 'X-Idempotency-Key: SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http POST https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods \\\n X-Idempotency-Key:SOME_STRING_VALUE", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method POST \\\n --header 'X-Idempotency-Key: SOME_STRING_VALUE' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods\");\nxhr.setRequestHeader(\"X-Idempotency-Key\", \"SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods\",\n \"method\": \"POST\",\n \"headers\": {\n \"X-Idempotency-Key\": \"SOME_STRING_VALUE\"\n }\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_returns/obligation_periods\",\n \"headers\": {\n \"X-Idempotency-Key\": \"SOME_STRING_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods\"),\n Headers =\n {\n { \"X-Idempotency-Key\", \"SOME_STRING_VALUE\" },\n },\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"X-Idempotency-Key\", \"SOME_STRING_VALUE\");\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nheaders = { 'X-Idempotency-Key': \"SOME_STRING_VALUE\" }\n\nconn.request(\"POST\", \"/v3.1/tax_returns/obligation_periods\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_returns/obligation_periods\"\n\nheaders = {\"X-Idempotency-Key\": \"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"POST\", url, headers=headers)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_types": { "get": { "summary": "Returns all Tax Types", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "query", "name": "items_per_page", "description": "Returns the given number of Tax Types per request.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "default": 20 } }, { "in": "query", "name": "page", "description": "Go to specific page of Tax Types", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all Tax Types", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxType" } }, "examples": { "200 response example": { "value": [ { "id": "string", "displayed_as": "string", "$path": "string", "federal_tax": true, "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_regions": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } ] } } } } } }, "tags": [ "Tax Types" ], "operationId": "getTaxTypes", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_types?items_per_page=20&page=SOME_INTEGER_VALUE&attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_types\"\n\nquerystring = {\"items_per_page\":\"20\",\"page\":\"SOME_INTEGER_VALUE\",\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/tax_types/{key}": { "get": { "summary": "Returns a Tax Type", "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "parameters": [ { "in": "path", "name": "key", "description": "The Tax Type Key.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "attributes", "description": "Specify the attributes that you want to expose for the Tax Type (expose all attributes with 'all'). These are in addition to the base attributes (name, path)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a Tax Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxType" }, "examples": { "200 response example": { "value": { "id": "string", "displayed_as": "string", "$path": "string", "federal_tax": true, "country": { "id": "string", "displayed_as": "string", "$path": "string" }, "address_regions": [ { "id": "string", "displayed_as": "string", "$path": "string" } ], "tax_rates": [ { "id": "string", "displayed_as": "string", "$path": "string" } ] } } } } } } }, "tags": [ "Tax Types" ], "operationId": "getTaxTypesKey", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url 'https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET 'https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - 'https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE'", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/tax_types/%7Bkey%7D?attributes=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/tax_types/%7Bkey%7D\"\n\nquerystring = {\"attributes\":\"SOME_STRING_VALUE\"}\n\nresponse = requests.request(\"GET\", url, params=querystring)\n\nprint(response.text)", "isAutoGenerated": true } ] } }, "/email_settings": { "get": { "summary": "Returns all Email Settings", "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 `Settings`: Full Access, Read Only", "responses": { "200": { "description": "Returns all Email Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettings" }, "examples": { "200 response example": { "value": { "default_messages": [ { "message_type": "string", "locale": "string", "message": "string" } ], "pdf_attached": true, "send_bcc": true, "updated_at": "2019-08-24T14:15:22Z" } } } } } } }, "tags": [ "Email Settings" ], "operationId": "getEmailSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request GET \\\n --url https://api.accounting.sage.com/v3.1/email_settings", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "http GET https://api.accounting.sage.com/v3.1/email_settings", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method GET \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/email_settings", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.accounting.sage.com/v3.1/email_settings\");\n\nxhr.send(data);", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/email_settings\",\n \"method\": \"GET\",\n \"headers\": {}\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/email_settings\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/email_settings\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/email_settings\");\nvar request = new RestRequest(Method.GET);\nIRestResponse response = client.Execute(request);", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\nconn.request(\"GET\", \"/v3.1/email_settings\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/email_settings\"\n\nresponse = requests.request(\"GET\", url)\n\nprint(response.text)", "isAutoGenerated": true } ] }, "put": { "summary": "Updates a Email Settings", "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 `Settings`: Full Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putEmailSettings" }, "examples": { "Request example": { "value": { "email_settings": { "pdf_attached": true, "send_bcc": true, "default_messages": [ { "message_type": "string", "locale": "string", "message": "string" } ] } }, "isAutoGenerated": true } } } }, "required": true }, "responses": { "200": { "description": "Updates a Email Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettings" }, "examples": { "200 response example": { "value": { "default_messages": [ { "message_type": "string", "locale": "string", "message": "string" } ], "pdf_attached": true, "send_bcc": true, "updated_at": "2019-08-24T14:15:22Z" } } } } } } }, "tags": [ "Email Settings" ], "operationId": "putEmailSettings", "x-codeSamples": [ { "lang": "shell_curl", "name": "Request example", "source": "curl --request PUT \\\n --url https://api.accounting.sage.com/v3.1/email_settings \\\n --header 'Content-Type: application/json' \\\n --data '{\"email_settings\":{\"pdf_attached\":true,\"send_bcc\":true,\"default_messages\":[{\"message_type\":\"string\",\"locale\":\"string\",\"message\":\"string\"}]}}'", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_httpie", "name": "Request example", "source": "echo '{\"email_settings\":{\"pdf_attached\":true,\"send_bcc\":true,\"default_messages\":[{\"message_type\":\"string\",\"locale\":\"string\",\"message\":\"string\"}]}}' | \\\n http PUT https://api.accounting.sage.com/v3.1/email_settings \\\n Content-Type:application/json", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "shell_wget", "name": "Request example", "source": "wget --quiet \\\n --method PUT \\\n --header 'Content-Type: application/json' \\\n --body-data '{\"email_settings\":{\"pdf_attached\":true,\"send_bcc\":true,\"default_messages\":[{\"message_type\":\"string\",\"locale\":\"string\",\"message\":\"string\"}]}}' \\\n --output-document \\\n - https://api.accounting.sage.com/v3.1/email_settings", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_xhr", "name": "Request example", "source": "const data = JSON.stringify({\n \"email_settings\": {\n \"pdf_attached\": true,\n \"send_bcc\": true,\n \"default_messages\": [\n {\n \"message_type\": \"string\",\n \"locale\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.accounting.sage.com/v3.1/email_settings\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "javascript_jquery", "name": "Request example", "source": "const settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://api.accounting.sage.com/v3.1/email_settings\",\n \"method\": \"PUT\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"processData\": false,\n \"data\": \"{\\\"email_settings\\\":{\\\"pdf_attached\\\":true,\\\"send_bcc\\\":true,\\\"default_messages\\\":[{\\\"message_type\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"message\\\":\\\"string\\\"}]}}\"\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "node_native", "name": "Request example", "source": "const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.accounting.sage.com\",\n \"port\": null,\n \"path\": \"/v3.1/email_settings\",\n \"headers\": {\n \"Content-Type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n email_settings: {\n pdf_attached: true,\n send_bcc: true,\n default_messages: [{message_type: 'string', locale: 'string', message: 'string'}]\n }\n}));\nreq.end();", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_httpclient", "name": "Request example", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Put,\n RequestUri = new Uri(\"https://api.accounting.sage.com/v3.1/email_settings\"),\n Content = new StringContent(\"{\\\"email_settings\\\":{\\\"pdf_attached\\\":true,\\\"send_bcc\\\":true,\\\"default_messages\\\":[{\\\"message_type\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"message\\\":\\\"string\\\"}]}}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\n }\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "csharp_restsharp", "name": "Request example", "source": "var client = new RestClient(\"https://api.accounting.sage.com/v3.1/email_settings\");\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"email_settings\\\":{\\\"pdf_attached\\\":true,\\\"send_bcc\\\":true,\\\"default_messages\\\":[{\\\"message_type\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"message\\\":\\\"string\\\"}]}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_python3", "name": "Request example", "source": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.accounting.sage.com\")\n\npayload = \"{\\\"email_settings\\\":{\\\"pdf_attached\\\":true,\\\"send_bcc\\\":true,\\\"default_messages\\\":[{\\\"message_type\\\":\\\"string\\\",\\\"locale\\\":\\\"string\\\",\\\"message\\\":\\\"string\\\"}]}}\"\n\nheaders = { 'Content-Type': \"application/json\" }\n\nconn.request(\"PUT\", \"/v3.1/email_settings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))", "mimeType": "application/json", "isAutoGenerated": true }, { "lang": "python_requests", "name": "Request example", "source": "import requests\n\nurl = \"https://api.accounting.sage.com/v3.1/email_settings\"\n\npayload = {\"email_settings\": {\n \"pdf_attached\": True,\n \"send_bcc\": True,\n \"default_messages\": [\n {\n \"message_type\": \"string\",\n \"locale\": \"string\",\n \"message\": \"string\"\n }\n ]\n }}\nheaders = {\"Content-Type\": \"application/json\"}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)", "mimeType": "application/json", "isAutoGenerated": true } ] } } }, "components": { "schemas": { "User": { "type": "object", "properties": { "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" }, "displayed_as": { "type": "string", "description": "Display text for the item" }, "id": { "type": "string", "description": "The unique identifier for the user" }, "first_name": { "type": "string", "description": "The first name of the user" }, "last_name": { "type": "string", "description": "The last name of the user" }, "initials": { "type": "string", "description": "The initials of the user" }, "email": { "type": "string", "description": "The email address of the user" }, "locale": { "type": "string", "description": "The locale of the user" } }, "description": "Returns the User" }, "putBusinesses": { "type": "object", "properties": { "business": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business" }, "address_line_1": { "type": "string", "description": "The first line of the business address" }, "address_line_2": { "type": "string", "description": "The second line of the business address" }, "city": { "type": "string", "description": "The business address town/city" }, "region": { "type": "string", "description": "The business address state/province/region" }, "postal_code": { "type": "string", "description": "The business address postal code/zipcode" }, "telephone": { "type": "string", "description": "The telephone of the business" }, "mobile": { "type": "string", "description": "The mobile of the business" }, "website": { "type": "string", "description": "The website of the business" } } } }, "description": "Updates a Business" }, "Business": { "type": "object", "properties": { "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" }, "displayed_as": { "type": "string", "description": "Display text for the item" }, "id": { "type": "string", "description": "The unique identifier for the business" }, "name": { "type": "string", "description": "The name of the business" }, "address_line_1": { "type": "string", "description": "The first line of the business address" }, "address_line_2": { "type": "string", "description": "The first line of the business address" }, "city": { "type": "string", "description": "The business address town/city" }, "postal_code": { "type": "string", "description": "The business address postal code/zipcode" }, "country": { "$ref": "#/components/schemas/Country" }, "region": { "type": "string", "description": "The business address state/province/region" }, "telephone": { "type": "string", "description": "The telephone of the business" }, "mobile": { "type": "string", "description": "The mobile of the business" }, "website": { "type": "string", "description": "The website of the business" }, "is_demo": { "type": "boolean", "description": "Indicates whether the business is for demo purposes" }, "ni_based": { "type": "boolean", "description": "Identifies a business as being based in Northern Ireland. \nonly applicable to UK business" }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" }, "description": "The business subscriptions" } }, "description": "Returns all Businesses" }, "Country": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the country" }, "displayed_as": { "type": "string", "description": "Display text for the country" } } }, "Subscription": { "type": "object", "properties": { "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" }, "displayed_as": { "type": "string", "description": "Display text for the item" }, "id": { "type": "string", "description": "The unique identifier for the subscription" }, "active": { "type": "boolean", "description": "Indicates whether the subscription is active" }, "status": { "type": "string" } } }, "putUser": { "type": "object", "properties": { "user": { "type": "object", "properties": { "first_name": { "type": "string", "description": "The first name of the user" }, "last_name": { "type": "string", "description": "The last name of the user" }, "initials": { "type": "string", "description": "The initials of the use" }, "locale": { "type": "string", "description": "The locale of the user", "enum": [ "en-GB", "en-IE", "en-US", "es-US", "en-CA", "fr-CA", "fr-FR", "de-DE", "es-ES" ] } } } }, "description": "Updates the User" }, "CoaAccount": { "type": "object", "properties": { "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" }, "ledger_account_group": { "$ref": "#/components/schemas/CoaGroupType" }, "name": { "type": "string", "maxLength": 200, "description": "The name for the COA account" }, "control_name": { "type": "string", "maxLength": 50, "description": "The system control name for the COA account.\n\nSystem control names are used in Accounting to identify the correct ledger account for booking taxes\netc.\n" }, "nominal_code": { "type": "integer", "format": "int32", "description": "The nominal code of the COA account" }, "ledger_account_type": { "$ref": "#/components/schemas/Base" }, "ledger_account_classification": { "$ref": "#/components/schemas/Base" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "fixed_tax_rate": { "type": "boolean", "description": "Indicates whether the default tax rate is fixed or may be changed per transaction" }, "cis_materials": { "type": "boolean", "description": "Indicates whether the COA account is flagged for CIS Materials" }, "cis_labour": { "type": "boolean", "description": "Indicates whether the COA account is flagged for CIS Labour" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Financial Accounts & Entries" }, "CoaGroupType": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" } } }, "Base": { "type": "object", "properties": { "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": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Settings" }, "CoaTemplate": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 25, "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": 50, "description": "The name for the COA template" }, "country": { "$ref": "#/components/schemas/Base" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Financial Accounts & Entries" }, "LedgerAccount": { "type": "object", "properties": { "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" }, "ledger_account_group": { "$ref": "#/components/schemas/CoaGroupType" }, "name": { "type": "string", "maxLength": 200, "description": "The name for the ledger account.\n\nChanges to this field do not propagate to other resources, namely not to the name of the associated\nbank_account (unlike the behaviour of the UI).\n" }, "display_name": { "type": "string", "maxLength": 200, "description": "The display name for the ledger account" }, "visible_scopes": { "type": "array", "items": { "type": "string" }, "description": "The visible scopes for the ledger account.\n\nThis indicates in which of the UI's areas the ledger account is displayed and available for user\nselection. Possible entries in this array are `bank`, `sales`, `purchasing`, `other_payment`,\n`other_receipt`, `reporting`, `journals`, `sales_eu`, `sales_row`, `purchasing_eu`, `purchasing_row`\nand `purchasing_hrc`.\n" }, "included_in_chart": { "type": "boolean", "description": "Indicates whether the ledger account is included in the chart of accounts" }, "nominal_code": { "type": "integer", "format": "int32", "description": "The nominal code of the ledger account" }, "ledger_account_type": { "$ref": "#/components/schemas/Base" }, "ledger_account_classification": { "$ref": "#/components/schemas/Base" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "fixed_tax_rate": { "type": "boolean", "description": "Indicates whether the default tax rate is fixed or may be changed per transaction" }, "visible_in_banking": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the banking area of the application" }, "visible_in_expenses": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the purchases area of the application" }, "visible_in_journals": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the journals area of the application" }, "visible_in_other_payments": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the other payments area of the application\n" }, "visible_in_other_receipts": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the other receipts area of the application\n" }, "visible_in_reporting": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the reporting area of the application" }, "visible_in_sales": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the sales area of the application" }, "balance_details": { "$ref": "#/components/schemas/LedgerAccountBalanceDetails" }, "is_control_account": { "type": "boolean", "description": "Indicates whether the ledger account is a control account.\n\nControl accounts cannot be removed. See also `control_name`.\n" }, "control_name": { "type": "string", "maxLength": 255, "description": "The control name for the ledger account.\n\nThis is used internally by Accounting to identify the correct ledger account for booking taxes etc.\nYou cannot add ledger accounts with control name and you cannot modify the control name of existing\nledger accounts.\n" }, "display_formatted": { "type": "string", "description": "The display name formatted based on coa_list_order in settings" }, "tax_recoverable": { "type": "boolean", "description": "Indicates that transactions posted to this ledger account have part recoverable taxes (Canada only)\n" }, "recoverable_percentage": { "type": "number", "format": "double", "description": "The partial recoverable tax rate (Canada only)" }, "non_recoverable_ledger_account": { "$ref": "#/components/schemas/LedgerAccount" }, "cis_materials": { "type": "boolean", "description": "Indicates whether the ledger account is flagged for CIS Materials" }, "tax_instalment": { "type": "boolean", "description": "Indicates whether the ledger account is flagged for Tax Intalment (Canada only)" }, "cis_labour": { "type": "boolean", "description": "Indicates whether the ledger account is flagged for CIS Labour" }, "gifi_code": { "type": "integer", "format": "int32", "description": "The GIFI code of the 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" } }, "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "x-sage-menusection": "Financial Accounts & Entries" }, "LedgerAccountBalanceDetails": { "type": "object", "properties": { "balance": { "type": "number", "format": "double", "description": "The account balance" }, "credit_or_debit": { "type": "string", "description": "Is the balance a debit or credit" }, "credits": { "type": "number", "format": "double", "description": "The credit balance" }, "debits": { "type": "number", "format": "double", "description": "The debit balance" }, "from_date": { "type": "string", "description": "The from date filter" }, "to_date": { "type": "string", "description": "The to date filter" } } }, "putLedgerAccounts": { "type": "object", "properties": { "ledger_account": { "type": "object", "properties": { "ledger_account_type_id": { "type": "string", "description": "The ledger account type for the ledger account" }, "included_in_chart": { "type": "boolean", "description": "Indicates whether the ledger account is included in the chart of accounts" }, "name": { "type": "string", "description": "The name for the ledger account.\n\nChanges to this field do not propagate to other resources, namely not to the name of the associated\nbank_account (unlike the behaviour of the UI).\n" }, "display_name": { "type": "string", "description": "The display name for the ledger account" }, "nominal_code": { "type": "integer", "format": "int32", "description": "The nominal code of the ledger account", "minimum": 1, "maximum": 99999999 }, "ledger_account_classification_id": { "type": "string", "description": "The ID of the Ledger Account Classification." }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "fixed_tax_rate": { "type": "boolean", "description": "Indicates whether the default tax rate is fixed or may be changed per transaction" }, "visible_in_banking": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the banking area of the application" }, "visible_in_expenses": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the purchases area of the application" }, "visible_in_journals": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the journals area of the application" }, "visible_in_other_payments": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the other payments area of the application\n" }, "visible_in_other_receipts": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the other receipts area of the application\n" }, "visible_in_reporting": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the reporting area of the application" }, "visible_in_sales": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the sales area of the application" }, "control_name": { "type": "string", "description": "The control name for the ledger account.\n\nThis is used internally by Accounting to identify the correct ledger account for booking taxes etc.\nYou cannot add ledger accounts with control name and you cannot modify the control name of existing\nledger accounts.\n" }, "tax_recoverable": { "type": "boolean", "description": "Indicates that transactions posted to this ledger account have part recoverable taxes (Canada only)\n" }, "recoverable_percentage": { "type": "number", "format": "double", "description": "The partial recoverable tax rate (Canada only)" }, "non_recoverable_ledger_account_id": { "type": "string", "description": "The ID of the Non Recoverable Ledger Account." }, "cis_materials": { "type": "boolean", "description": "Indicates whether the ledger account is flagged for CIS Materials" }, "cis_labour": { "type": "boolean", "description": "Indicates whether the ledger account is flagged for CIS Labour" }, "gifi_code": { "type": "integer", "format": "int32", "description": "The GIFI code of the 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", "minimum": 1000, "maximum": 9999 } } } }, "required": [ "ledger_account" ], "description": "Updates a Ledger Account" }, "postLedgerAccounts": { "type": "object", "properties": { "ledger_account": { "type": "object", "properties": { "ledger_account_type_id": { "type": "string", "description": "The ledger account type for the ledger account" }, "included_in_chart": { "type": "boolean", "description": "Indicates whether the ledger account is included in the chart of accounts" }, "name": { "type": "string", "description": "The name for the ledger account.\n\nChanges to this field do not propagate to other resources, namely not to the name of the associated\nbank_account (unlike the behaviour of the UI).\n" }, "display_name": { "type": "string", "description": "The display name for the ledger account" }, "nominal_code": { "type": "integer", "format": "int32", "description": "The nominal code of the ledger account", "minimum": 1, "maximum": 99999999 }, "ledger_account_classification_id": { "type": "string", "description": "The ID of the Ledger Account Classification." }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "fixed_tax_rate": { "type": "boolean", "description": "Indicates whether the default tax rate is fixed or may be changed per transaction" }, "visible_in_banking": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the banking area of the application" }, "visible_in_expenses": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the purchases area of the application" }, "visible_in_journals": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the journals area of the application" }, "visible_in_other_payments": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the other payments area of the application\n" }, "visible_in_other_receipts": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the other receipts area of the application\n" }, "visible_in_reporting": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the reporting area of the application" }, "visible_in_sales": { "type": "boolean", "description": "Indicates whether the ledger account is displayed in the sales area of the application" }, "control_name": { "type": "string", "description": "The control name for the ledger account.\n\nThis is used internally by Accounting to identify the correct ledger account for booking taxes etc.\nYou cannot add ledger accounts with control name and you cannot modify the control name of existing\nledger accounts.\n" }, "tax_recoverable": { "type": "boolean", "description": "Indicates that transactions posted to this ledger account have part recoverable taxes (Canada only)\n" }, "recoverable_percentage": { "type": "number", "format": "double", "description": "The partial recoverable tax rate (Canada only)" }, "non_recoverable_ledger_account_id": { "type": "string", "description": "The ID of the Non Recoverable Ledger Account." }, "cis_materials": { "type": "boolean", "description": "Indicates whether the ledger account is flagged for CIS Materials" }, "cis_labour": { "type": "boolean", "description": "Indicates whether the ledger account is flagged for CIS Labour" }, "gifi_code": { "type": "integer", "format": "int32", "description": "The GIFI code of the 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", "minimum": 1000, "maximum": 9999 } }, "required": [ "ledger_account_type_id", "included_in_chart", "name", "display_name", "nominal_code" ] } }, "required": [ "ledger_account" ], "description": "Creates a Ledger Account" }, "Journal": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "date": { "type": "string", "format": "date", "description": "The date of the journal" }, "reference": { "type": "string", "maxLength": 255, "description": "A reference for the journal" }, "description": { "type": "string", "maxLength": 200, "description": "A description of the journal" }, "total": { "type": "number", "format": "double", "description": "The total for the journal" }, "journal_code": { "$ref": "#/components/schemas/JournalCode" }, "journal_lines": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLine" }, "description": "The journal lines" }, "migrated": { "type": "boolean", "description": "Indicates if the journal was migrated from another system." } }, "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Journals`: Full Access", "x-sage-menusection": "Financial Accounts & Entries" }, "JournalCode": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/JournalCodeType" }, "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": "### 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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "x-sage-menusection": "Settings" }, "JournalCodeType": { "type": "object", "properties": { "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": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Financial Accounts & Entries" }, "JournalLine": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "ledger_account": { "$ref": "#/components/schemas/LedgerAccount" }, "details": { "type": "string", "description": "A description of the journal line" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the journal line" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the journal line" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "include_on_tax_return": { "type": "boolean", "description": "Indicates whether the journal line should affect the tax return" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the journal line is tax reconciled or not." }, "cleared": { "type": "boolean", "description": "Indicates if the journal line is cleared or not.\n\nWill be true when a journal item has been matched with a bank feed or statement.\n" }, "bank_reconciled": { "type": "boolean", "description": "Indicates if the journal line is bank reconciled or not." }, "journal_line_foreign_currency": { "type": "string", "description": "Indicates if the journal line is with a foreign currency bank account." } } }, "AnalysisTypeLineItem": { "type": "object", "properties": { "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" }, "analysis_type": { "$ref": "#/components/schemas/AnalysisType" } } }, "AnalysisType": { "type": "object", "properties": { "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" }, "active_areas": { "type": "array", "description": "The areas for which the analysis type is available", "items": {} }, "analysis_type_level": { "type": "array", "description": "The analysis type level", "items": {} }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeCategory" }, "description": "The analysis type categories for the analysis type" }, "name": { "type": "string", "maxLength": 50, "description": "The name of the analysis type" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n*\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Settings`: Full Access" }, "AnalysisTypeCategory": { "type": "object", "properties": { "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" }, "code": { "type": "string", "maxLength": 10, "description": "The code for the analysis type category" }, "name": { "type": "string", "maxLength": 50, "description": "The name of the analysis type category" }, "combined_id": { "type": "string", "description": "The combined_id of the analysis type category" }, "analysis_type": { "$ref": "#/components/schemas/Base" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n*\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Settings`: Full Access" }, "postJournals": { "type": "object", "properties": { "journal": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "The date of the journal" }, "reference": { "type": "string", "description": "A reference for the journal" }, "description": { "type": "string", "description": "A description of the journal" }, "total": { "type": "number", "format": "double", "description": "The total for the journal" }, "journal_code": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the journal code" }, "code": { "type": "string", "description": "The code of the journal code" }, "journal_code_type_id": { "type": "string", "description": "The ID of the Journal Code Type." }, "control_name": { "type": "string", "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" } } }, "journal_lines": { "type": "array", "description": "The journal lines", "items": { "type": "object", "properties": { "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the journal line" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the journal line" }, "details": { "type": "string", "description": "A description of the journal line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "include_on_tax_return": { "type": "boolean", "description": "Indicates whether the journal line should affect the tax return" } }, "required": [ "ledger_account_id", "debit", "credit" ] } } }, "required": [ "date", "reference", "journal_lines" ] } }, "required": [ "journal" ], "description": "Creates a Journal" }, "postJournalCodes": { "type": "object", "properties": { "journal_code": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the journal code" }, "code": { "type": "string", "description": "The code of the journal code" }, "journal_code_type_id": { "type": "string", "description": "The journal code type of the journal code" }, "control_name": { "type": "string", "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" } }, "required": [ "name", "code", "journal_code_type_id" ] } }, "required": [ "journal_code" ], "description": "Creates a Journal Code" }, "putJournalCodes": { "type": "object", "properties": { "journal_code": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the journal code" }, "code": { "type": "string", "description": "The code of the journal code" }, "journal_code_type_id": { "type": "string", "description": "The journal code type of the journal code" }, "control_name": { "type": "string", "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" } } } }, "required": [ "journal_code" ], "description": "Updates a Journal Code" }, "LedgerEntry": { "type": "object", "properties": { "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" }, "date": { "type": "string", "format": "date", "description": "The date of the ledger entry" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the ledger entry" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the ledger entry" }, "ledger_account": { "$ref": "#/components/schemas/LedgerAccount" }, "transaction": { "$ref": "#/components/schemas/Transaction" }, "contact": { "$ref": "#/components/schemas/Contact" }, "deleted": { "type": "boolean", "description": "Indicates whether the ledger entry has been deleted or not" }, "tax_rate": { "$ref": "#/components/schemas/TaxRate" }, "description": { "type": "string", "description": "The ledger entry description" }, "journal_code": { "$ref": "#/components/schemas/JournalCode" } }, "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 `Journals`: Read Only, Full Access", "x-sage-menusection": "Financial Accounts & Entries" }, "Transaction": { "type": "object", "properties": { "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" }, "date": { "type": "string", "format": "date", "description": "The date of the transaction" }, "deleted": { "type": "boolean", "description": "Indicates whether the transaction has been deleted" }, "reference": { "type": "string", "maxLength": 255, "description": "The transaction reference" }, "total": { "type": "number", "format": "double", "description": "The transaction total in the base currency" }, "total_in_transaction_currency": { "type": "number", "format": "double", "description": "The transaction total in the transaction's origin's currency. This is null for some origin types." }, "contact": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "origin": { "$ref": "#/components/schemas/TransactionOrigin" }, "audit_trail_id": { "type": "string", "description": "The original entity that generated the transaction" }, "number_of_attachments": { "type": "string", "description": "The number of attachments related to the transaction" } }, "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 `Journals`: Read Only, Full Access", "x-sage-menusection": "Bank, Payments & Receipts" }, "TransactionOrigin": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the associated item, e.g. an invoice\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute." }, "outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the associated item, e.g. an invoice\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute." }, "currency": { "$ref": "#/components/schemas/Base" }, "status": { "$ref": "#/components/schemas/Base" }, "sent": { "type": "boolean", "description": "Indicates whether the associated item, e.g. an invoice, has been sent. This attribute is only present for sales items (not purchase)\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute." } } }, "Link": { "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" } } }, "Contact": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "balance": { "type": "number", "format": "double", "description": "The contact balance" }, "contact_types": { "type": "array", "items": { "$ref": "#/components/schemas/Base" }, "description": "The type of the contact. It has to be either CUSTOMER or VENDOR" }, "name": { "type": "string", "maxLength": 100, "description": "The contact's full name or business name" }, "reference": { "type": "string", "maxLength": 10, "description": "Unique reference for the contact" }, "default_sales_ledger_account": { "$ref": "#/components/schemas/LedgerAccount" }, "default_sales_tax_rate": { "$ref": "#/components/schemas/Base" }, "default_purchase_ledger_account": { "$ref": "#/components/schemas/LedgerAccount" }, "tax_number": { "type": "string", "maxLength": 255, "description": "The VAT registration number of the contact. The format will be validated." }, "notes": { "type": "string", "maxLength": 4000, "description": "The notes for the contact" }, "locale": { "type": "string", "maxLength": 10, "description": "The locale for the contact" }, "main_address": { "$ref": "#/components/schemas/Address" }, "delivery_address": { "$ref": "#/components/schemas/Address" }, "main_contact_person": { "$ref": "#/components/schemas/ContactPerson" }, "bank_account_details": { "$ref": "#/components/schemas/BankAccountDetails" }, "credit_limit": { "type": "number", "format": "double", "description": "Custom credit limit amount for the contact not applicable to Start" }, "credit_days": { "type": "integer", "format": "int32", "description": "Custom credit days for the contact.\nIf returned as null in a GET response, you may want to GET /invoice_settings\nand use 'customer_credit_days'/'vendor_credit_days' as default/fallback according\nto your use case.\n" }, "credit_terms": { "type": "string", "enum": [ "month_end_invoice", "date_from_invoice", "immediate_invoice", "month_end_payment", "date_from_payment", "immediate_payment" ], "description": "Credit terms options determine how invoice due dates are calculated.\nOptions include: end of next month, a delay of supplier credit_days and immediately.\nOnly: month_end_invoice, date_from_invoice, immediate_invoice, month_end_payment,\ndate_from_payment, immediate_payment are valid values.\nIf returned as null in a GET response, you may want to GET /invoice_settings\nand use 'customer_credit_terms'/'vendor_credit_terms' as default.\n" }, "credit_terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "Custom terms and conditions for the contact. If set will override global /invoice_settings\ndefault terms and conditions.\nCustomers only\n" }, "product_sales_price_type": { "$ref": "#/components/schemas/Base" }, "source_guid": { "type": "string", "maxLength": 255, "description": "Used when importing contacts from external sources" }, "currency": { "$ref": "#/components/schemas/Base" }, "aux_reference": { "type": "string", "maxLength": 4, "description": "Auxiliary reference. Previously used for German \"Kreditorennummer\" and \"Debitorennummer\"" }, "registered_number": { "type": "string", "maxLength": 25, "description": "The registered number of the contact's business. Only used for German businesses and represents the \"Steuernummer\" there (not the \"USt-ID\")." }, "deletable": { "type": "boolean", "description": "Indicates whether the contact can be deleted successfully" }, "tax_treatment": { "$ref": "#/components/schemas/ContactTaxTreatment" }, "email": { "type": "string", "maxLength": 100, "description": "The email address for the given contact" }, "tax_calculation": { "type": "string", "description": "France: The tax calculation method used to define tax\ntreatment Vendors only\n\nSpain: Defines if contact is a retailer and tax is subject\nto Recargo de Equivalencia Customers only\nUnited Kingdom: Defines if contact tax treatment is domestic reverse\ncharge Customers & Suppliers\n" }, "auxiliary_account": { "type": "string", "maxLength": 25, "description": "Auxiliary account - used when auxiliary accounting is enabled in business settings.\nAvailable only in Spain and France\n" }, "gdpr_obfuscated": { "type": "boolean", "description": "General Data Protection Regulation (GDPR) came into effect on 25th May 2018. It introduces new rules for how business owners manage their contacts' personal data. When this field returns 'true', means that the contact has been requested to be obfuscated and you can not create any artifact (sales invoices, purchase invoices, ...) but you can still check previously created artifacts." }, "system": { "type": "boolean", "description": "Identifies a contact as being a system contact used for processing specific transaction types and reserved specifically for those transaction types such as tax return payments/refunds." }, "has_unfinished_recurring_invoices": { "type": "boolean", "description": "Indicates whether the contact is associated with any unfinished recurring invoices" }, "cis_registered": { "type": "boolean", "description": "Identifies a contact as being registered as CIS.only applicable to UK business" }, "ni_based": { "type": "boolean", "description": "Identifies a contact as being based in Northern Ireland." }, "is_active": { "type": "boolean", "description": "Identifies a contact as being active" }, "gb_based": { "type": "boolean", "description": "Identifies a contact as being based in Great Britain." }, "cis_settings": { "$ref": "#/components/schemas/ContactCisSettings" }, "destination_vat_blocking": { "type": "boolean", "description": "Identifies a contact should be blocked due to destination vat" } }, "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "x-sage-menusection": "Contacts, Addresses & Countries" }, "Address": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "contact": { "$ref": "#/components/schemas/Base" }, "address_type": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "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": "### 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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "x-sage-menusection": "Contacts, Addresses & Countries" }, "ContactPerson": { "type": "object", "properties": { "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" }, "contact_person_types": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonType" }, "description": "The contact person types for the contact person. Get possible types by retrieving\n\n all available contact person types\n.\n" }, "name": { "type": "string", "maxLength": 50, "description": "The name of the contact person" }, "job_title": { "type": "string", "maxLength": 50, "description": "The job title of the contact person" }, "telephone": { "type": "string", "maxLength": 50, "description": "The telephone number of the contact person" }, "mobile": { "type": "string", "maxLength": 50, "description": "The mobile number of the contact person" }, "email": { "type": "string", "maxLength": 100, "description": "The email address of the contact person" }, "fax": { "type": "string", "maxLength": 50, "description": "The fax number of the contact person" }, "is_main_contact": { "type": "boolean", "description": "Indicates whether this is the main contact person. Per contact, only one main contact can be selected." }, "address": { "$ref": "#/components/schemas/Base" }, "is_preferred_contact": { "type": "boolean", "description": "Indicates whether this contact person is a preferred contact" } }, "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 mentioned role in one of the listed areas:\n* Area: `Contacts`: Restricted Access, Full Access", "x-sage-menusection": "Contacts, Addresses & Countries" }, "ContactPersonType": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 15, "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": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Contacts, Addresses & Countries" }, "BankAccountDetails": { "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" } } }, "ContactTaxTreatment": { "type": "object", "properties": { "home_tax": { "type": "boolean", "description": "Indicates a contact where home country tax rules should be applied" }, "eu_tax_registered": { "type": "boolean", "description": "Indicates a contact where EC tax rules should be applied" }, "eu_not_tax_registered": { "type": "boolean", "description": "Indicates an EU contact without a tax number - home tax rules should be applied" }, "rest_of_world_tax": { "type": "boolean", "description": "Indicates a contact where rest of world tax rules should be applied" }, "is_importer": { "type": "boolean", "description": "Indicates a contact where import rules should be appliedOnly used for suppliers and FR, ES, IE and UK businesses" } } }, "ContactCisSettings": { "type": "object", "properties": { "registered_cis_name": { "type": "string", "description": "the CIS name for the Contact" }, "subcontractor_verification_number": { "type": "string", "description": "The CIS Verification number for the contact" }, "deduction_rate": { "$ref": "#/components/schemas/ContactCisDeductionRate" } } }, "ContactCisDeductionRate": { "type": "object", "properties": { "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" } } }, "TaxRate": { "type": "object", "properties": { "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", "description": "The name of the tax rate" }, "agency": { "type": "string", "description": "The agency name (US Only)" }, "percentage": { "type": "number", "format": "double", "description": "The current tax rate percentage" }, "percentages": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRatePercentage" }, "description": "The tax rate percentage and date ranges they apply to" }, "is_visible": { "type": "boolean", "description": "Indicates whether the tax rate is displayed in the application" }, "retailer": { "type": "boolean", "description": "Indicates if tax rate is a retailer rate or not" }, "editable": { "type": "boolean", "description": "Indicates whether a tax rate can be edited" }, "deletable": { "type": "boolean", "description": "Indicates whether a tax rate can be deleted" }, "is_combined_rate": { "type": "boolean", "description": "Indicates whether the tax rate is made up of component tax rates" }, "component_tax_rates": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentTaxRate" }, "description": "The component tax rates which make up a combined rate" } }, "description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "x-sage-menusection": "Settings" }, "TaxRatePercentage": { "type": "object", "properties": { "percentage": { "type": "number", "format": "double", "description": "The percentage of the rate" }, "from_date": { "type": "string", "format": "date", "description": "The start date for the rate" }, "to_date": { "type": "string", "format": "date", "description": "The end date for the rate" } } }, "ComponentTaxRate": { "type": "object", "properties": { "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", "description": "The name of the tax rate" }, "agency": { "type": "string", "description": "The agency name (US Only)" }, "percentage": { "type": "number", "format": "double", "description": "The current tax rate percentage" }, "percentages": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRatePercentage" }, "description": "The tax rate percentage and date ranges they apply to" }, "is_visible": { "type": "boolean", "description": "Indicates whether the tax rate is displayed in the application" }, "retailer": { "type": "boolean", "description": "Indicates if tax rate is a retailer rate or not" }, "editable": { "type": "boolean", "description": "Indicates whether a tax rate can be edited" }, "deletable": { "type": "boolean", "description": "Indicates whether a tax rate can be deleted" }, "is_combined_rate": { "type": "boolean", "description": "Indicates whether the tax rate is made up of component tax rates" } } }, "UnpostedTransaction": { "type": "object", "properties": { "id": { "type": "string", "description": "The unposted transaction id" }, "displayed_as": { "type": "string", "description": "Display text for the transaction" }, "$path": { "type": "string", "description": "The API path for the resource" }, "created_at": { "type": "string", "description": "The date when the transaction was created as RFC3339 compliant string" }, "updated_at": { "type": "string", "description": "The date when the transaction was updated as RFC3339 compliant string" }, "transaction_date": { "type": "string", "description": "The string of the transactions transaction date" }, "transaction_type": { "type": "string", "description": "The string of the transactions transaction type" }, "description": { "type": "string", "description": "The string of the transactions description" }, "bank_account": { "$ref": "#/components/schemas/BankAccount" }, "amount": { "type": "string", "description": "The string representation of a decimal value of the transactions amount" }, "bank_feed_category_name": { "type": "string", "description": "The string of the transactions bank feed category" } }, "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 `Journals`: Read Only, Full Access", "x-sage-menusection": "Bank, Payments & Receipts" }, "BankAccount": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/BankAccountDetails" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "bank_account_type": { "$ref": "#/components/schemas/Base" }, "balance": { "type": "number", "format": "double", "description": "The bank account balance" }, "main_address": { "$ref": "#/components/schemas/Address" }, "main_contact_person": { "$ref": "#/components/schemas/BankAccountContact" }, "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": { "$ref": "#/components/schemas/JournalCode" }, "default_payment_method": { "$ref": "#/components/schemas/Base" }, "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." }, "currency": { "$ref": "#/components/schemas/Base" } }, "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", "x-sage-menusection": "Bank, Payments & Receipts" }, "BankAccountContact": { "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" } } }, "Attachment": { "type": "object", "properties": { "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" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "file": { "type": "string", "description": "The base64 encoded representation of the file" }, "mime_type": { "type": "string", "description": "The mime type of the attachment" }, "description": { "type": "string", "description": "The description of the attachment" }, "file_extension": { "type": "string", "description": "The file extension of the attachment" }, "transaction": { "$ref": "#/components/schemas/Base" }, "file_size": { "type": "integer", "format": "int32", "description": "The file size of the attachment in Bytes" }, "file_name": { "type": "string", "description": "The file name of the attachment" }, "$file_path": { "type": "string", "description": "The file path of the attachment" }, "attachment_context_type": { "$ref": "#/components/schemas/Base" }, "attachment_context": { "$ref": "#/components/schemas/Base" }, "is_public": { "type": "boolean", "description": "Flag to determine whether the attachment should be visible to customers" }, "created_at": { "type": "string", "format": "date-time", "description": "The datetime when the attachment was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The datetime when the attachment was last updated" } }, "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "x-sage-menusection": "Attachments" }, "postAttachments": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "file": { "type": "string", "description": "The base64 encoded representation of the file" }, "file_name": { "type": "string", "description": "The file name of the attachment" }, "mime_type": { "type": "string", "description": "The mime type of the attachment" }, "description": { "type": "string", "description": "The description of the attachment" }, "file_extension": { "type": "string", "description": "The file extension of the attachment" }, "transaction_id": { "type": "string", "description": "The ID of the Transaction." }, "file_size": { "type": "integer", "format": "int32", "description": "The file size of the attachment in Bytes", "minimum": 0, "maximum": 2621440 }, "attachment_context_type_id": { "type": "string", "description": "The ID of the Attachment Context Type." }, "attachment_context_id": { "type": "string", "description": "The ID of the Attachment Context." }, "is_public": { "type": "boolean", "description": "Flag to determine whether the attachment should be visible to customers" } }, "required": [ "file", "file_name", "mime_type" ] } }, "required": [ "attachment" ], "description": "Creates a Attachment" }, "putAttachments": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "file": { "type": "string", "description": "The base64 encoded representation of the file" }, "file_name": { "type": "string", "description": "The file name of the attachment" }, "mime_type": { "type": "string", "description": "The mime type of the attachment" }, "description": { "type": "string", "description": "The description of the attachment" }, "file_extension": { "type": "string", "description": "The file extension of the attachment" }, "transaction_id": { "type": "string", "description": "The ID of the Transaction." }, "file_size": { "type": "integer", "format": "int32", "description": "The file size of the attachment in Bytes", "minimum": 0, "maximum": 2621440 }, "attachment_context_type_id": { "type": "string", "description": "The ID of the Attachment Context Type." }, "attachment_context_id": { "type": "string", "description": "The ID of the Attachment Context." }, "is_public": { "type": "boolean", "description": "Flag to determine whether the attachment should be visible to customers" } } } }, "required": [ "attachment" ], "description": "Updates a Attachment" }, "postBankAccounts": { "type": "object", "properties": { "bank_account": { "type": "object", "properties": { "bank_account_type_id": { "type": "string", "description": "The bank account type for the bank account" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "nominal_code": { "type": "integer", "format": "int32", "description": "The nominal code of the bank account", "minimum": 1, "maximum": 99999999 }, "default_payment_method_id": { "type": "string", "description": "The ID of the Default Payment Method." }, "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", "minimum": 1000, "maximum": 9999 }, "is_active": { "type": "boolean", "description": "Indicates whether the Bank account is active or inactive." }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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" } }, "required": [ "account_name" ] }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "name": { "type": "string", "description": "The custom name of the address" }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." }, "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" } } }, "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" } } }, "journal_code": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the journal code" }, "code": { "type": "string", "description": "The code of the journal code" }, "journal_code_type_id": { "type": "string", "description": "The ID of the Journal Code Type." }, "control_name": { "type": "string", "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" } } } }, "required": [ "bank_account_type_id" ] } }, "required": [ "bank_account" ], "description": "Creates a Bank Account" }, "putBankAccounts": { "type": "object", "properties": { "bank_account": { "type": "object", "properties": { "bank_account_type_id": { "type": "string", "description": "The bank account type for the bank account" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "nominal_code": { "type": "integer", "format": "int32", "description": "The nominal code of the bank account", "minimum": 1, "maximum": 99999999 }, "default_payment_method_id": { "type": "string", "description": "The ID of the Default Payment Method." }, "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", "minimum": 1000, "maximum": 9999 }, "is_active": { "type": "boolean", "description": "Indicates whether the Bank account is active or inactive." }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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" } } }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "name": { "type": "string", "description": "The custom name of the address" }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." }, "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" } } }, "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" } } }, "journal_code": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the journal code" }, "code": { "type": "string", "description": "The code of the journal code" }, "journal_code_type_id": { "type": "string", "description": "The ID of the Journal Code Type." }, "control_name": { "type": "string", "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" } } } } } }, "required": [ "bank_account" ], "description": "Updates a Bank Account" }, "BankDeposit": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "from_bank_account": { "$ref": "#/components/schemas/BankAccount" }, "to_bank_account": { "$ref": "#/components/schemas/BankAccount" }, "date": { "type": "string", "format": "date", "description": "User generated date of transaction, not necessarily when it was created" }, "reference": { "type": "string", "maxLength": 255, "description": "Reference" }, "cash_amount": { "type": "number", "format": "double", "description": "Cash total in the deposit" }, "cheque_amount": { "type": "number", "format": "double", "description": "Cheque total in the deposit" }, "total_amount": { "type": "number", "format": "double", "description": "Total of cash and cheques in the deposit" } }, "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", "x-sage-menusection": "Bank, Payments & Receipts" }, "postBankDeposits": { "type": "object", "properties": { "bank_deposit": { "type": "object", "properties": { "from_bank_account_id": { "type": "string", "description": "From bank account - money leaves this account" }, "to_bank_account_id": { "type": "string", "description": "To bank account - money goes into this account" }, "date": { "type": "string", "format": "date", "description": "User generated date of transaction, not necessarily when it was created" }, "reference": { "type": "string", "description": "Reference" }, "cash_amount": { "type": "number", "format": "double", "description": "Cash total in the deposit" }, "cheque_amount": { "type": "number", "format": "double", "description": "Cheque total in the deposit" }, "total_amount": { "type": "number", "format": "double", "description": "Total of cash and cheques in the deposit" } }, "required": [ "from_bank_account_id", "to_bank_account_id", "date", "reference", "cash_amount" ] } }, "required": [ "bank_deposit" ], "description": "Creates a Bank Deposit" }, "BankReconciliation": { "type": "object", "properties": { "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" }, "bank_account": { "$ref": "#/components/schemas/Base" }, "statement_date": { "type": "string", "format": "date", "description": "The date of the bank reconciliation" }, "statement_end_balance": { "type": "number", "format": "double", "description": "The statement end balance for the reconciliation" }, "reference": { "type": "string", "maxLength": 255, "description": "A reference for the bank reconciliation" }, "total_received": { "type": "number", "format": "double", "description": "The total amount received" }, "total_paid": { "type": "number", "format": "double", "description": "The total amount paid" }, "starting_balance": { "type": "number", "format": "double", "description": "The starting balance of the bank reconciliation" }, "closing_balance": { "type": "number", "format": "double", "description": "The closing balance of the bank reconciliation" }, "reconciled_balance": { "type": "number", "format": "double", "description": "The reconciled balance of the bank reconciliation" }, "balance_difference": { "type": "number", "format": "double", "description": "The difference between the statement end balance and the reconciled balance" }, "status": { "$ref": "#/components/schemas/BankReconciliationStatus" } }, "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", "x-sage-menusection": "Bank, Payments & Receipts" }, "BankReconciliationStatus": { "type": "object", "properties": { "id": { "type": "string", "description": "The bank reconciliation status id" }, "displayed_as": { "type": "string", "description": "The bank reconciliation status name" } } }, "postBankReconciliations": { "type": "object", "properties": { "bank_reconciliation": { "type": "object", "properties": { "bank_account_id": { "type": "string", "description": "The bank account the reconciliation relates to" }, "statement_date": { "type": "string", "format": "date", "description": "The date of the bank reconciliation" }, "statement_end_balance": { "type": "number", "format": "double", "description": "The statement end balance for the reconciliation" }, "reference": { "type": "string", "description": "A reference for the bank reconciliation" }, "total_received": { "type": "number", "format": "double", "description": "The total amount received" }, "total_paid": { "type": "number", "format": "double", "description": "The total amount paid" }, "starting_balance": { "type": "number", "format": "double", "description": "The starting balance of the bank reconciliation" }, "closing_balance": { "type": "number", "format": "double", "description": "The closing balance of the bank reconciliation" }, "reconciled_balance": { "type": "number", "format": "double", "description": "The reconciled balance of the bank reconciliation" }, "balance_difference": { "type": "number", "format": "double", "description": "The difference between the statement end balance and the reconciled balance" }, "status_id": { "type": "string", "description": "The ID of the Status." } }, "required": [ "bank_account_id" ] } }, "required": [ "bank_reconciliation" ], "description": "Creates a Bank Reconciliation" }, "putBankReconciliations": { "type": "object", "properties": { "bank_reconciliation": { "type": "object", "properties": { "bank_account_id": { "type": "string", "description": "The bank account the reconciliation relates to" }, "statement_date": { "type": "string", "format": "date", "description": "The date of the bank reconciliation" }, "statement_end_balance": { "type": "number", "format": "double", "description": "The statement end balance for the reconciliation" }, "reference": { "type": "string", "description": "A reference for the bank reconciliation" }, "total_received": { "type": "number", "format": "double", "description": "The total amount received" }, "total_paid": { "type": "number", "format": "double", "description": "The total amount paid" }, "starting_balance": { "type": "number", "format": "double", "description": "The starting balance of the bank reconciliation" }, "closing_balance": { "type": "number", "format": "double", "description": "The closing balance of the bank reconciliation" }, "reconciled_balance": { "type": "number", "format": "double", "description": "The reconciled balance of the bank reconciliation" }, "balance_difference": { "type": "number", "format": "double", "description": "The difference between the statement end balance and the reconciled balance" }, "status_id": { "type": "string", "description": "The ID of the Status." } } } }, "required": [ "bank_reconciliation" ], "description": "Updates a Bank Reconciliation" }, "BankTransfer": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "from_bank_account": { "$ref": "#/components/schemas/BankAccount" }, "to_bank_account": { "$ref": "#/components/schemas/BankAccount" }, "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" }, "postBankTransfers": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "from_bank_account_id": { "type": "string", "description": "The bank account that the money was transfered from" }, "to_bank_account_id": { "type": "string", "description": "The bank account that the money was transfered to" }, "date": { "type": "string", "format": "date", "description": "The date of the bank transfer" }, "amount": { "type": "number", "format": "double", "description": "The amount of the bank transfer" }, "reference": { "type": "string", "description": "The reference for the bank transfer" }, "description": { "type": "string", "description": "The description for the bank transfer" } }, "required": [ "from_bank_account_id", "to_bank_account_id", "date", "amount" ] } }, "required": [ "bank_transfer" ], "description": "Creates a Bank Transfer" }, "putBankTransfers": { "type": "object", "properties": { "bank_transfer": { "type": "object", "properties": { "from_bank_account_id": { "type": "string", "description": "The bank account that the money was transfered from" }, "to_bank_account_id": { "type": "string", "description": "The bank account that the money was transfered to" }, "date": { "type": "string", "format": "date", "description": "The date of the bank transfer" }, "amount": { "type": "number", "format": "double", "description": "The amount of the bank transfer" }, "reference": { "type": "string", "description": "The reference for the bank transfer" }, "description": { "type": "string", "description": "The description for the bank transfer" } } } }, "required": [ "bank_transfer" ], "description": "Updates a Bank Transfer" }, "postAddresses": { "type": "object", "properties": { "address": { "type": "object", "properties": { "address_type_id": { "type": "string", "description": "Defines the nature of the address (Shipping, Billing, Head Office etc.). Start defaults to \"Sales\" for Customers and \"Purchasing\" for Vendors" }, "name": { "type": "string", "description": "The custom name of the address" }, "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" }, "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The related bank account of the address, if the address belongs to a bank account." }, "contact_id": { "type": "string", "description": "The related contact of the address, if the address belongs to a contact." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } }, "required": [ "address_type_id", "name", "is_main_address" ] } }, "required": [ "address" ], "description": "Creates a Address" }, "putAddresses": { "type": "object", "properties": { "address": { "type": "object", "properties": { "address_type_id": { "type": "string", "description": "Defines the nature of the address (Shipping, Billing, Head Office etc.). Start defaults to \"Sales\" for Customers and \"Purchasing\" for Vendors" }, "name": { "type": "string", "description": "The custom name of the address" }, "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" }, "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The related bank account of the address, if the address belongs to a bank account." }, "contact_id": { "type": "string", "description": "The related contact of the address, if the address belongs to a contact." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } } }, "required": [ "address" ], "description": "Updates a Address" }, "AddressRegion": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 10, "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "Display text for the item" }, "$path": { "type": "string", "description": "The API path for the resource" }, "code": { "type": "string", "maxLength": 8, "description": "The code of the address region" }, "name": { "type": "string", "description": "The name of the address region" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Contacts, Addresses & Countries" }, "postContacts": { "type": "object", "properties": { "contact": { "type": "object", "properties": { "name": { "type": "string", "description": "The contact's full name or business name" }, "contact_type_ids": { "type": "array", "description": "The IDs of the Contact Types.", "items": { "type": "string" } }, "reference": { "type": "string", "description": "Unique reference for the contact" }, "default_sales_ledger_account_id": { "type": "string", "description": "The ID of the Default Sales Ledger Account." }, "default_sales_tax_rate_id": { "type": "string", "description": "The ID of the Default Sales Tax Rate." }, "default_purchase_ledger_account_id": { "type": "string", "description": "The ID of the Default Purchase Ledger Account." }, "tax_number": { "type": "string", "description": "The VAT registration number of the contact. The format will be validated." }, "notes": { "type": "string", "description": "The notes for the contact" }, "locale": { "type": "string", "description": "The locale for the contact" }, "credit_limit": { "type": "number", "format": "double", "description": "Custom credit limit amount for the contact. \nnot applicable to Start" }, "credit_days": { "type": "integer", "format": "int32", "description": "Custom credit days for the contact. \nIf returned as null in a GET response, you may want to GET /invoice_settings\nand use 'customer_credit_days'/'vendor_credit_days' as default/fallback according\nto your use case.\n", "minimum": 0, "maximum": 365 }, "credit_terms": { "type": "string", "description": "Credit terms options determine how invoice due dates are calculated.\nOptions include: end of next month, a delay of supplier credit_days and immediately.\nOnly: month_end_invoice, date_from_invoice, immediate_invoice, month_end_payment,\ndate_from_payment, immediate_payment are valid values.\nIf returned as null in a GET response, you may want to GET /invoice_settings\nand use 'customer_credit_terms'/'vendor_credit_terms' as default.\n", "enum": [ "month_end_invoice", "date_from_invoice", "immediate_invoice", "month_end_payment", "date_from_payment", "immediate_payment" ] }, "credit_terms_and_conditions": { "type": "string", "description": "Custom terms and conditions for the contact. If set will override global /invoice_settings\ndefault terms and conditions.\nCustomers only\n" }, "product_sales_price_type_id": { "type": "string", "description": "The ID of the Product Sales Price Type." }, "source_guid": { "type": "string", "description": "Used when importing contacts from external sources" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "aux_reference": { "type": "string", "description": "Auxiliary reference. Previously used for German \"Kreditorennummer\" and \"Debitorennummer\"." }, "registered_number": { "type": "string", "description": "The registered number of the contact's business. Only used for German businesses and represents the \"Steuernummer\" there (not the \"USt-ID\")." }, "tax_calculation": { "type": "string", "description": "France: The tax calculation method used to define tax\ntreatment Vendors only\n\nSpain: Defines if contact is a retailer and tax is subject\nto Recargo de Equivalencia Customers only\nUnited Kingdom: Defines if contact tax treatment is domestic reverse\ncharge Customers & Suppliers\n" }, "auxiliary_account": { "type": "string", "description": "Auxiliary account - used when auxiliary accounting is enabled in business settings.\nAvailable only in Spain and France\n" }, "destination_vat_blocking": { "type": "boolean", "description": "Identifies a contact should be blocked due to destination vat" }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "name": { "type": "string", "description": "The custom name of the address" }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." }, "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" } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "name": { "type": "string", "description": "The custom name of the address" }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." }, "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" } } }, "main_contact_person": { "type": "object", "properties": { "contact_person_type_ids": { "type": "array", "description": "The IDs of the Contact Person Types.", "items": { "type": "string" } }, "name": { "type": "string", "description": "The name of the contact person" }, "job_title": { "type": "string", "description": "The job title of the contact person" }, "telephone": { "type": "string", "description": "The telephone number of the contact person" }, "mobile": { "type": "string", "description": "The mobile number of the contact person" }, "email": { "type": "string", "description": "The email address of the contact person" }, "fax": { "type": "string", "description": "The fax number of the contact person" }, "is_main_contact": { "type": "boolean", "description": "Indicates whether this is the main contact person. Per contact, only one main contact can be selected." }, "address_id": { "type": "string", "description": "The ID of the Address." }, "is_preferred_contact": { "type": "boolean", "description": "Indicates whether this contact person is a preferred contact" } } }, "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" } } }, "tax_treatment": { "type": "object", "properties": { "home_tax": { "type": "boolean", "description": "Indicates a contact where home country tax rules should be applied" }, "eu_tax_registered": { "type": "boolean", "description": "Indicates a contact where EC tax rules should be applied" }, "eu_not_tax_registered": { "type": "boolean", "description": "Indicates an EU contact without a tax number - home tax rules should be applied" }, "rest_of_world_tax": { "type": "boolean", "description": "Indicates a contact where rest of world tax rules should be applied" }, "is_importer": { "type": "boolean", "description": "Indicates a contact where import rules should be appliedOnly used for suppliers and FR, ES, IE and UK businesses" } } } }, "required": [ "name", "contact_type_ids" ] } }, "required": [ "contact" ], "description": "Creates a Contact" }, "putContacts": { "type": "object", "properties": { "contact": { "type": "object", "properties": { "name": { "type": "string", "description": "The contact's full name or business name" }, "contact_type_ids": { "type": "array", "description": "The IDs of the Contact Types.", "items": { "type": "string" } }, "reference": { "type": "string", "description": "Unique reference for the contact" }, "default_sales_ledger_account_id": { "type": "string", "description": "The ID of the Default Sales Ledger Account." }, "default_sales_tax_rate_id": { "type": "string", "description": "The ID of the Default Sales Tax Rate." }, "default_purchase_ledger_account_id": { "type": "string", "description": "The ID of the Default Purchase Ledger Account." }, "tax_number": { "type": "string", "description": "The VAT registration number of the contact. The format will be validated." }, "notes": { "type": "string", "description": "The notes for the contact" }, "locale": { "type": "string", "description": "The locale for the contact" }, "credit_limit": { "type": "number", "format": "double", "description": "Custom credit limit amount for the contact not applicable to Start" }, "credit_days": { "type": "integer", "format": "int32", "description": "Custom credit days for the contact.\nIf returned as null in a GET response, you may want to GET /invoice_settings\nand use 'customer_credit_days'/'vendor_credit_days' as default/fallback according\nto your use case.\n", "minimum": 0, "maximum": 365 }, "credit_terms": { "type": "string", "description": "Credit terms options determine how invoice due dates are calculated.\nOptions include: end of next month, a delay of supplier credit_days and immediately.\nOnly: month_end_invoice, date_from_invoice, immediate_invoice, month_end_payment,\ndate_from_payment, immediate_payment are valid values.\nIf returned as null in a GET response, you may want to GET /invoice_settings\nand use 'customer_credit_terms'/'vendor_credit_terms' as default.\n", "enum": [ "month_end_invoice", "date_from_invoice", "immediate_invoice", "month_end_payment", "date_from_payment", "immediate_payment" ] }, "credit_terms_and_conditions": { "type": "string", "description": "Custom terms and conditions for the contact. If set will override global /invoice_settings\ndefault terms and conditions.\nCustomers only\n" }, "product_sales_price_type_id": { "type": "string", "description": "The ID of the Product Sales Price Type." }, "source_guid": { "type": "string", "description": "Used when importing contacts from external sources" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "aux_reference": { "type": "string", "description": "Auxiliary reference. Previously used for German \"Kreditorennummer\" and \"Debitorennummer\"." }, "registered_number": { "type": "string", "description": "The registered number of the contact's business. Only used for German businesses and represents the \"Steuernummer\" there (not the \"USt-ID\")." }, "tax_calculation": { "type": "string", "description": "France: The tax calculation method used to define tax\ntreatment Vendors only\n\nSpain: Defines if contact is a retailer and tax is subject\nto Recargo de Equivalencia Customers only\nUnited Kingdom: Defines if contact tax treatment is domestic reverse\ncharge Customers & Suppliers\n" }, "auxiliary_account": { "type": "string", "description": "Auxiliary account - used when auxiliary accounting is enabled in business settings.\nAvailable only in Spain and France\n" }, "destination_vat_blocking": { "type": "boolean", "description": "Identifies a contact should be blocked due to destination vat" }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "name": { "type": "string", "description": "The custom name of the address" }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." }, "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" } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "name": { "type": "string", "description": "The custom name of the address" }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." }, "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" } } }, "main_contact_person": { "type": "object", "properties": { "contact_person_type_ids": { "type": "array", "description": "The IDs of the Contact Person Types.", "items": { "type": "string" } }, "name": { "type": "string", "description": "The name of the contact person" }, "job_title": { "type": "string", "description": "The job title of the contact person" }, "telephone": { "type": "string", "description": "The telephone number of the contact person" }, "mobile": { "type": "string", "description": "The mobile number of the contact person" }, "email": { "type": "string", "description": "The email address of the contact person" }, "fax": { "type": "string", "description": "The fax number of the contact person" }, "is_main_contact": { "type": "boolean", "description": "Indicates whether this is the main contact person. Per contact, only one main contact can be selected." }, "address_id": { "type": "string", "description": "The ID of the Address." }, "is_preferred_contact": { "type": "boolean", "description": "Indicates whether this contact person is a preferred contact" } } }, "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" } } }, "tax_treatment": { "type": "object", "properties": { "home_tax": { "type": "boolean", "description": "Indicates a contact where home country tax rules should be applied" }, "eu_tax_registered": { "type": "boolean", "description": "Indicates a contact where EC tax rules should be applied" }, "eu_not_tax_registered": { "type": "boolean", "description": "Indicates an EU contact without a tax number - home tax rules should be applied" }, "rest_of_world_tax": { "type": "boolean", "description": "Indicates a contact where rest of world tax rules should be applied" }, "is_importer": { "type": "boolean", "description": "Indicates a contact where import rules should be appliedOnly used for suppliers and FR, ES, IE and UK businesses" } } } } } }, "required": [ "contact" ], "description": "Updates a Contact" }, "postContactPersons": { "type": "object", "properties": { "contact_person": { "type": "object", "properties": { "address_id": { "type": "string", "description": "The address of the contact person" }, "name": { "type": "string", "description": "The name of the contact person" }, "contact_person_type_ids": { "type": "array", "description": "The IDs of the Contact Person Types.", "items": { "type": "string" } }, "job_title": { "type": "string", "description": "The job title of the contact person" }, "telephone": { "type": "string", "description": "The telephone number of the contact person" }, "mobile": { "type": "string", "description": "The mobile number of the contact person" }, "email": { "type": "string", "description": "The email address of the contact person" }, "fax": { "type": "string", "description": "The fax number of the contact person" }, "is_main_contact": { "type": "boolean", "description": "Indicates whether this is the main contact person. Per contact, only one main contact can be selected." }, "is_preferred_contact": { "type": "boolean", "description": "Indicates whether this contact person is a preferred contact" } }, "required": [ "address_id", "name", "contact_person_type_ids" ] } }, "required": [ "contact_person" ], "description": "Creates a Contact Person" }, "putContactPersons": { "type": "object", "properties": { "contact_person": { "type": "object", "properties": { "address_id": { "type": "string", "description": "The address of the contact person" }, "name": { "type": "string", "description": "The name of the contact person" }, "contact_person_type_ids": { "type": "array", "description": "The IDs of the Contact Person Types.", "items": { "type": "string" } }, "job_title": { "type": "string", "description": "The job title of the contact person" }, "telephone": { "type": "string", "description": "The telephone number of the contact person" }, "mobile": { "type": "string", "description": "The mobile number of the contact person" }, "email": { "type": "string", "description": "The email address of the contact person" }, "fax": { "type": "string", "description": "The fax number of the contact person" }, "is_main_contact": { "type": "boolean", "description": "Indicates whether this is the main contact person. Per contact, only one main contact can be selected." }, "is_preferred_contact": { "type": "boolean", "description": "Indicates whether this contact person is a preferred contact" } } } }, "required": [ "contact_person" ], "description": "Updates a Contact Person" }, "BusinessExchangeRate": { "type": "object", "properties": { "displayed_as": { "type": "string", "description": "Display text for the item" }, "$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" }, "rate": { "type": "number", "format": "double", "description": "The exchange rate" }, "inverse_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate" }, "base_currency": { "$ref": "#/components/schemas/Base" }, "currency": { "$ref": "#/components/schemas/Base" } }, "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 `Settings`: Full Access", "x-sage-menusection": "Currencies & Exchange" }, "postBusinessExchangeRates": { "type": "object", "properties": { "business_exchange_rate": { "type": "object", "properties": { "currency_id": { "type": "string", "description": "The foreign currency" }, "rate": { "type": "number", "format": "double", "description": "The exchange rate" }, "inverse_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate" }, "base_currency_id": { "type": "string", "description": "The ID of the Base Currency." } }, "required": [ "currency_id", "rate" ] } }, "required": [ "business_exchange_rate" ], "description": "Creates a Business Exchange Rate" }, "putBusinessExchangeRates": { "type": "object", "properties": { "business_exchange_rate": { "type": "object", "properties": { "currency_id": { "type": "string", "description": "The foreign currency" }, "rate": { "type": "number", "format": "double", "description": "The exchange rate" }, "inverse_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate" }, "base_currency_id": { "type": "string", "description": "The ID of the Base Currency." } } } }, "required": [ "business_exchange_rate" ], "description": "Updates a Business Exchange Rate" }, "ExchangeRate": { "type": "object", "properties": { "displayed_as": { "type": "string", "description": "Display text for the item" }, "$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" }, "rate": { "type": "number", "format": "double", "description": "The exchange rate" }, "inverse_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate" }, "base_currency": { "$ref": "#/components/schemas/Base" }, "currency": { "$ref": "#/components/schemas/Base" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Currencies & Exchange" }, "LiveExchangeRate": { "type": "object", "properties": { "displayed_as": { "type": "string", "description": "Display text for the item" }, "$path": { "type": "string", "description": "The API path for the resource" }, "rate": { "type": "number", "format": "double", "description": "The exchange rate" }, "inverse_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate" }, "base_currency": { "$ref": "#/components/schemas/Base" }, "currency": { "$ref": "#/components/schemas/Base" }, "retrieved_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Currencies & Exchange" }, "PurchaseCorrectiveInvoice": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "transaction": { "$ref": "#/components/schemas/Transaction" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "contact": { "$ref": "#/components/schemas/Contact" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the invoice" }, "vendor_reference": { "type": "string", "maxLength": 31, "description": "The vendor reference for the invoice" }, "notes": { "type": "string", "maxLength": 2000, "description": "Invoice notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the invoice including any payments, allocations and discounts" }, "outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "string", "description": "The inverse exchange rate for the credit note" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "base_currency_outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice in base currency" }, "status": { "$ref": "#/components/schemas/Base" }, "void_reason": { "type": "string", "maxLength": 255, "description": "The reason the invoice was voided" }, "invoice_lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoiceLineItem" }, "description": "The invoice lines of the invoice" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The invoice tax analysis (Optional for Spain, restricted for all other regions)" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "last_paid": { "type": "string", "format": "date", "description": "The date of the last payment" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "original_invoice": { "$ref": "#/components/schemas/Generic" }, "original_invoice_number": { "type": "string", "description": "The number relating to the original invoice (Spain only)" }, "original_invoice_date": { "type": "string", "description": "The Invoice date relating to the original invoice (Spain only)" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the artefact is tax reconciled or not." }, "import": { "type": "boolean", "description": "Indicates whether import rules are applied to the artefact. Only used for Accounting businesses, where the vendor is flagged as importer." } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ช๐Ÿ‡ธ\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" }, "PurchaseInvoiceLineItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "description": { "type": "string", "description": "The description for the invoice line" }, "product": { "$ref": "#/components/schemas/Product" }, "service": { "$ref": "#/components/schemas/Service" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the invoice line" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type": { "$ref": "#/components/schemas/Base" }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the invoice line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the invoice line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the invoice line is tax recoverable or not" } } }, "Product": { "type": "object", "properties": { "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" }, "deletable": { "type": "boolean", "description": "Indicates whether the product can be deleted" }, "deactivatable": { "type": "boolean", "description": "Indicates whether the product can be deactivated" }, "used_on_recurring_invoice": { "type": "boolean", "description": "Indicates whether the product has been used on a recurring invoice" }, "item_code": { "type": "string", "maxLength": 255, "description": "The item code for the product" }, "description": { "type": "string", "maxLength": 255, "description": "The product description" }, "notes": { "type": "string", "maxLength": 500, "description": "The notes for the product" }, "sales_ledger_account": { "$ref": "#/components/schemas/Base" }, "sales_tax_rate": { "$ref": "#/components/schemas/Base" }, "purchase_ledger_account": { "$ref": "#/components/schemas/Base" }, "usual_supplier": { "$ref": "#/components/schemas/Contact" }, "purchase_tax_rate": { "$ref": "#/components/schemas/Base" }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the product" }, "sales_prices": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPrice" }, "description": "The sales prices for the product" }, "source_guid": { "type": "string", "maxLength": 255, "description": "Used when importing products from external sources" }, "purchase_description": { "type": "string", "maxLength": 250, "description": "The product purchase description" }, "active": { "type": "boolean", "description": "Indicates whether the product is active" }, "catalog_item_type": { "$ref": "#/components/schemas/Base" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "x-sage-menusection": "Products & Services" }, "SalesPrice": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of 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" }, "price_name": { "type": "string", "description": "The name of the product sales price" }, "price": { "type": "number", "format": "double", "description": "The sales price amount" }, "price_includes_tax": { "type": "boolean", "description": "Indicates whether the sales price already includes tax" }, "product_sales_price_type": { "$ref": "#/components/schemas/Base" } } }, "Service": { "type": "object", "properties": { "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" }, "deletable": { "type": "boolean", "description": "Indicates whether the service can be deleted" }, "deactivatable": { "type": "boolean", "description": "Indicates whether the service can be deactivated" }, "used_on_recurring_invoice": { "type": "boolean", "description": "Indicates whether the service has been used on a recurring invoice" }, "item_code": { "type": "string", "maxLength": 255, "description": "The item code for the service" }, "description": { "type": "string", "maxLength": 255, "description": "The service description" }, "notes": { "type": "string", "maxLength": 500, "description": "The notes for the service" }, "sales_ledger_account": { "$ref": "#/components/schemas/Base" }, "purchase_ledger_account": { "$ref": "#/components/schemas/Base" }, "sales_tax_rate": { "$ref": "#/components/schemas/Base" }, "purchase_tax_rate": { "$ref": "#/components/schemas/Base" }, "sales_rates": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" }, "description": "The sales rates for the service" }, "source_guid": { "type": "string", "maxLength": 255, "description": "Used when importing services from external sources" }, "purchase_description": { "type": "string", "maxLength": 250, "description": "The service purchase description" }, "usual_supplier": { "$ref": "#/components/schemas/Contact" }, "active": { "type": "boolean", "description": "Indicates whether the service is active" }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the service" }, "oss_service": { "type": "boolean", "description": "Indicates whether the service is One Stop Shop" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "x-sage-menusection": "Products & Services" }, "Rate": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of 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" }, "rate_name": { "type": "string", "description": "The name of the service rate" }, "rate": { "type": "number", "format": "double", "description": "The rate amount" }, "rate_includes_tax": { "type": "boolean", "description": "Indicates whether the rate already includes tax" }, "service_rate_type": { "$ref": "#/components/schemas/Base" } } }, "TaxBreakdown": { "type": "object", "properties": { "tax_rate": { "$ref": "#/components/schemas/Base" }, "percentage": { "type": "number", "format": "double", "description": "The tax rate percentage" }, "amount": { "type": "number", "format": "double", "description": "The tax amount for the given tax rate" } } }, "ArtefactTaxAnalysis": { "type": "object", "properties": { "tax_rate": { "$ref": "#/components/schemas/Base" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } }, "ArtefactDetailedTaxAnalysis": { "type": "object", "properties": { "tax_rates_breakdown": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysisBreakdown" }, "total_net": { "type": "number", "format": "double", "description": "The total net amount for all tax rates" }, "total_tax": { "type": "number", "format": "double", "description": "The total tax amount for all tax rates" }, "total": { "type": "number", "format": "double", "description": "The total amount for all tax rates" }, "total_goods_amount": { "type": "number", "format": "double", "description": "The total amount relating to goods for all tax rates" }, "total_services_amount": { "type": "number", "format": "double", "description": "The total amount relating to services for all tax rates" }, "base_currency_total_net": { "type": "number", "format": "double", "description": "The base currency total net amount for all tax rates" }, "base_currency_total_tax": { "type": "number", "format": "double", "description": "The base currency total tax amount for all tax rates" }, "base_currency_total": { "type": "number", "format": "double", "description": "The total base currency amount for all tax rates" }, "base_currency_total_goods_amount": { "type": "number", "format": "double", "description": "The total base currency amount relating to goods for all tax rates" }, "base_currency_total_services_amount": { "type": "number", "format": "double", "description": "The total base currency amount relating to services for all tax rates" }, "total_retailer_tax": { "type": "number", "format": "double", "description": "The total retailer tax amount for all tax rates" } } }, "ArtefactDetailedTaxAnalysisBreakdown": { "type": "object", "properties": { "tax_rate": { "$ref": "#/components/schemas/TaxRate" }, "name": { "type": "string", "description": "The tax rate name" }, "percentage": { "type": "number", "format": "double", "description": "The tax rate percentage" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "retail_tax_amount": { "type": "number", "format": "double", "description": "The retailer tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "services_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The base currency net amount for the tax rate" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The base currency tax amount for the tax rate" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The base currency total amount for the tax rate" }, "base_currency_goods_amount": { "type": "number", "format": "double", "description": "The total base currency amount for the tax rate relating to goods" }, "base_currency_services_amount": { "type": "number", "format": "double", "description": "The total base currency amount for the tax rate relating to services" } } }, "PaymentAllocation": { "type": "object", "properties": { "links": { "type": "array", "items": { "$ref": "#/components/schemas/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": { "$ref": "#/components/schemas/ContactAllocation" }, "artefact": { "$ref": "#/components/schemas/Generic" }, "contact_payment": { "$ref": "#/components/schemas/ContactPayment" }, "displayed_as": { "type": "string", "description": "Display text for the item" }, "negative_payment": { "type": "boolean", "description": "This is a negative payment" } } }, "ContactAllocation": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "transaction": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "allocated_artefacts": { "type": "array", "items": { "$ref": "#/components/schemas/AllocatedArtefact" }, "description": "The payment lines of the payment" } }, "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 areas `Sales`, `Purchases`, and `Contacts`: Full Access", "x-sage-menusection": "Contacts, Addresses & Countries" }, "AllocatedArtefact": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "artefact": { "$ref": "#/components/schemas/Generic" }, "amount": { "type": "number", "format": "double", "description": "The allocated amount" } } }, "Generic": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" } } }, "ContactPayment": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "transaction": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "payment_method": { "$ref": "#/components/schemas/Base" }, "contact": { "$ref": "#/components/schemas/Base" }, "bank_account": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/AllocatedPaymentArtefact" }, "description": "The allocated artefacts" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "payment_on_account": { "$ref": "#/components/schemas/PaymentOnAccount" }, "editable": { "type": "boolean", "description": "Indicates whether payment can be edited" } }, "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`: Restricted Access, Full Access", "x-sage-menusection": "Contacts, Addresses & Countries" }, "AllocatedPaymentArtefact": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "artefact": { "$ref": "#/components/schemas/Generic" }, "amount": { "type": "number", "format": "double", "description": "The allocated amount" }, "discount": { "type": "number", "format": "double", "description": "The allocated discount" } } }, "PaymentOnAccount": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" } } }, "postPurchaseCorrectiveInvoices": { "type": "object", "properties": { "purchase_corrective_invoice": { "type": "object", "properties": { "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "vendor_reference": { "type": "string", "description": "The vendor reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "string", "description": "The inverse exchange rate for the credit note" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "original_invoice_id": { "type": "string", "description": "The ID of the Original Invoice. (Spain only)" }, "original_invoice_number": { "type": "string", "description": "The number relating to the original invoice (Spain only)" }, "original_invoice_date": { "type": "string", "description": "The Invoice date relating to the original invoice (Spain only)" }, "invoice_lines": { "type": "array", "items": { "type": "object", "properties": { "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "description": { "type": "string", "description": "The description for the invoice line" }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the invoice line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the invoice line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the invoice line is tax recoverable or not" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "purchase_corrective_invoice" ], "description": "Creates a Purchase Corrective Invoice" }, "putPurchaseCorrectiveInvoices": { "type": "object", "properties": { "purchase_corrective_invoice": { "type": "object", "properties": { "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "vendor_reference": { "type": "string", "description": "The vendor reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "string", "description": "The inverse exchange rate for the credit note" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "original_invoice_id": { "type": "string", "description": "The ID of the Original Invoice. (Spain only)" }, "original_invoice_number": { "type": "string", "description": "The number relating to the original invoice (Spain only)" }, "original_invoice_date": { "type": "string", "description": "The Invoice date relating to the original invoice (Spain only)" }, "invoice_lines": { "type": "array", "items": { "type": "object", "properties": { "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "description": { "type": "string", "description": "The description for the invoice line" }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the invoice line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the invoice line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the invoice line is tax recoverable or not" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "purchase_corrective_invoice" ], "description": "Updates a Purchase Corrective Invoice" }, "PurchaseCreditNote": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "transaction": { "$ref": "#/components/schemas/Transaction" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether postponed accounting rules are applied to the artefact. Only used for UK and IE accounting businesses, where the vendor is flagged as importer" }, "import": { "type": "boolean", "description": "Indicates whether import rules are applied to the artefact. Only used for UK, IE, FR and ES Accounting businesses, where the vendor is flagged as importer." }, "vat_exempt_consignment": { "type": "boolean", "description": "Indicates whether vat exempt import is applied to the artefact. Only used for a UK business, where the artefact has the consignment checkbox selected." }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "is_cis": { "type": "boolean", "description": "Identifies an artefact as CIS (Construction Industry Scheme) applicable - UK only" }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "has_cis_labour": { "type": "boolean", "description": "Identifies an artefact as having CIS Labour line items" }, "has_cis_materials": { "type": "boolean", "description": "Identifies an artefact as having CIS Materials line items" }, "contact": { "$ref": "#/components/schemas/Contact" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n purchase credit note (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the purchase credit note (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n purchase credit note (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the purchase credit note (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the purchase credit note is part recoverable or not (Canada only)" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the credit note was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the credit note was created" }, "date": { "type": "string", "format": "date", "description": "The date of the credit note" }, "original_invoice_date": { "type": "string", "format": "date", "description": "The date of the original invoice" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the credit note" }, "vendor_reference": { "type": "string", "maxLength": 31, "description": "The vendor reference for the credit note" }, "notes": { "type": "string", "maxLength": 2000, "description": "credit note notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the credit note" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the credit note including any payments, allocations and discounts" }, "outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the credit note" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the credit note" }, "inverse_exchange_rate": { "type": "string", "description": "The inverse exchange rate for the credit note" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note in base currency" }, "base_currency_outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the credit note in base currency" }, "status": { "$ref": "#/components/schemas/Base" }, "void_reason": { "type": "string", "maxLength": 255, "description": "The reason the credit note was voided" }, "credit_note_lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseCreditNoteLineItem" }, "description": "The credit note lines of the credit note" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The credit note tax analysis" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "last_paid": { "type": "string", "format": "date", "description": "The date of the last payment" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the purchase credit note is tax reconciled or not." }, "migrated": { "type": "boolean", "description": "Indicates if the purchase credit note was migrated from another system." }, "tax_calculation_method": { "type": "string", "description": "The tax calculation method, if applicable, for this purchase credit note, returns invoice or cash." }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax)" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\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" }, "PurchaseCreditNoteLineItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "description": { "type": "string", "description": "The description for the credit note line" }, "product": { "$ref": "#/components/schemas/Product" }, "service": { "$ref": "#/components/schemas/Service" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the credit note line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the credit note line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the credit note line" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the credit note line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the credit note line" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the credit note line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the credit note line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the credit note line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the credit note line in base currency" }, "base_currency_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the credit note line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the credit note line in base currency" }, "eu_goods_services_type": { "$ref": "#/components/schemas/Base" }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the credit note line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the credit note line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the credit note line is tax recoverable or not" } } }, "postPurchaseCreditNotes": { "type": "object", "properties": { "purchase_credit_note": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the purchase credit note relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the credit note" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether postponed accounting rules are applied to the artefact. Only used for UK and IE accounting businesses, where the vendor is flagged as importer" }, "vat_exempt_consignment": { "type": "boolean", "description": "Indicates whether vat exempt import is applied to the artefact. Only used for a UK business, where the artefact has the consignment checkbox selected." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n purchase credit note (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the purchase credit note (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n purchase credit note (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the purchase credit note (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the purchase credit note is part recoverable or not (Canada only)" }, "contact_name": { "type": "string", "description": "The name of the contact when the credit note was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the credit note was created" }, "original_invoice_date": { "type": "string", "format": "date", "description": "The date of the original invoice" }, "reference": { "type": "string", "description": "The reference for the credit note" }, "vendor_reference": { "type": "string", "description": "The vendor reference for the credit note" }, "notes": { "type": "string", "description": "credit note notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the credit note" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the credit note" }, "inverse_exchange_rate": { "type": "string", "description": "The inverse exchange rate for the credit note" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax)" }, "credit_note_lines": { "type": "array", "description": "The credit note lines of the credit note", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the credit note line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the credit note line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the credit note line" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the credit note line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the credit note line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the credit note line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the credit note line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the credit note line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the credit note line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the credit note line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the credit note line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the credit note line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the credit note line is tax recoverable or not" } }, "required": [ "description", "ledger_account_id", "quantity", "unit_price" ] } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } }, "required": [ "contact_id", "date", "credit_note_lines" ] } }, "required": [ "purchase_credit_note" ], "description": "Creates a Purchase Credit Note" }, "putPurchaseCreditNotes": { "type": "object", "properties": { "purchase_credit_note": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the purchase credit note relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the credit note" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether postponed accounting rules are applied to the artefact. Only used for UK and IE accounting businesses, where the vendor is flagged as importer" }, "vat_exempt_consignment": { "type": "boolean", "description": "Indicates whether vat exempt import is applied to the artefact. Only used for a UK business, where the artefact has the consignment checkbox selected." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n purchase credit note (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the purchase credit note (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n purchase credit note (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the purchase credit note (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the purchase credit note is part recoverable or not (Canada only)" }, "contact_name": { "type": "string", "description": "The name of the contact when the credit note was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the credit note was created" }, "original_invoice_date": { "type": "string", "format": "date", "description": "The date of the original invoice" }, "reference": { "type": "string", "description": "The reference for the credit note" }, "vendor_reference": { "type": "string", "description": "The vendor reference for the credit note" }, "notes": { "type": "string", "description": "credit note notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the credit note" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the credit note" }, "inverse_exchange_rate": { "type": "string", "description": "The inverse exchange rate for the credit note" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax)" }, "credit_note_lines": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the credit note line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the credit note line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the credit note line" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the credit note line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the credit note line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the credit note line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the credit note line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the credit note line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the credit note line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the credit note line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the credit note line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the credit note line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the credit note line is tax recoverable or not" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "purchase_credit_note" ], "description": "Updates a Purchase Credit Note" }, "PurchaseInvoice": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "transaction": { "$ref": "#/components/schemas/Transaction" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether postponed accounting rules are applied to the artefact. Only used for UK and IE accounting businesses, where the vendor is flagged as importer" }, "import": { "type": "boolean", "description": "Indicates whether import rules are applied to the artefact. Only used for UK, IE, FR and ES Accounting businesses, where the vendor is flagged as importer." }, "vat_exempt_consignment": { "type": "boolean", "description": "Indicates whether vat exempt import is applied to the artefact. Only used for a UK business, where the artefact has the consignment checkbox selected." }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "is_cis": { "type": "boolean", "description": "Identifies an artefact as CIS (Construction Industry Scheme) applicable - UK only" }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "has_cis_labour": { "type": "boolean", "description": "Identifies an artefact as having CIS Labour line items" }, "has_cis_materials": { "type": "boolean", "description": "Identifies an artefact as having CIS Materials line items" }, "contact": { "$ref": "#/components/schemas/Contact" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n purchase invoice (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the purchase invoice (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n purchase invoice (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the purchase invoice (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the purchase invoice is part recoverable or not (Canada only)" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the invoice" }, "vendor_reference": { "type": "string", "maxLength": 31, "description": "The vendor reference for the invoice" }, "notes": { "type": "string", "maxLength": 2000, "description": "Invoice notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the invoice including any payments, allocations and discounts" }, "outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "base_currency_outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice in base currency" }, "status": { "$ref": "#/components/schemas/Base" }, "void_reason": { "type": "string", "maxLength": 255, "description": "The reason the invoice was voided" }, "invoice_lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoiceLineItem" }, "description": "The invoice lines of the invoice" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The invoice tax analysis (Optional for Spain, restricted for all other regions)" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "last_paid": { "type": "string", "format": "date", "description": "The date of the last payment" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate) and Spain (IRPF)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "corrections": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseCorrectiveInvoice" }, "description": "The corrective entries associated with the invoice" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the purchase invoice is tax reconciled or not." }, "migrated": { "type": "boolean", "description": "Indicates if the purchase invoice was migrated from another system." }, "tax_calculation_method": { "type": "string", "description": "The tax calculation method, if applicable, for this purchase invoice, returns invoice or cash." } }, "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" }, "postPurchaseInvoices": { "type": "object", "properties": { "purchase_invoice": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the purchase invoice relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether postponed accounting rules are applied to the artefact. Only used for UK and IE accounting businesses, where the vendor is flagged as importer" }, "vat_exempt_consignment": { "type": "boolean", "description": "Indicates whether vat exempt import is applied to the artefact. Only used for a UK business, where the artefact has the consignment checkbox selected." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n purchase invoice (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the purchase invoice (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n purchase invoice (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the purchase invoice (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the purchase invoice is part recoverable or not (Canada only)" }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "vendor_reference": { "type": "string", "description": "The vendor reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate) and Spain (IRPF)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "invoice_lines": { "type": "array", "description": "The invoice lines of the invoice", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the invoice line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the invoice line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the invoice line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the invoice line is tax recoverable or not" } }, "required": [ "description", "ledger_account_id", "quantity", "unit_price" ] } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } }, "required": [ "contact_id", "date", "due_date", "invoice_lines" ] } }, "required": [ "purchase_invoice" ], "description": "Creates a Purchase Invoice" }, "putPurchaseInvoices": { "type": "object", "properties": { "purchase_invoice": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the purchase invoice relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether postponed accounting rules are applied to the artefact. Only used for UK and IE accounting businesses, where the vendor is flagged as importer" }, "vat_exempt_consignment": { "type": "boolean", "description": "Indicates whether vat exempt import is applied to the artefact. Only used for a UK business, where the artefact has the consignment checkbox selected." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n purchase invoice (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the purchase invoice (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n purchase invoice (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the purchase invoice (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the purchase invoice is part recoverable or not (Canada only)" }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "vendor_reference": { "type": "string", "description": "The vendor reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate) and Spain (IRPF)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "invoice_lines": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the invoice line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland Only)" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the invoice line" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the invoice line" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the invoice line is tax recoverable or not" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "purchase_invoice" ], "description": "Updates a Purchase Invoice" }, "PurchaseQuickEntry": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "quick_entry_type": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "date": { "type": "string", "format": "date", "description": "The date of the quick entry" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the quick entry" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the quick entry" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quick entry" }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "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": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/TaxBreakdown" }, "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": { "$ref": "#/components/schemas/Base" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "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" }, "postPurchaseQuickEntries": { "type": "object", "properties": { "purchase_quick_entry": { "type": "object", "properties": { "quick_entry_type_id": { "type": "string", "description": "The type of quick entry e.g. invoice or credit note" }, "date": { "type": "string", "format": "date", "description": "The date of the quick entry" }, "contact_id": { "type": "string", "description": "The contact the quick entry relates to" }, "reference": { "type": "string", "description": "The reference for the quick entry" }, "ledger_account_id": { "type": "string", "description": "The associated ledger account" }, "contact_name": { "type": "string", "description": "The name of the contact when the quick entry was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the quick entry was created" }, "details": { "type": "string", "description": "A description of the quick entry" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the quick entry" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quick entry" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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_total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "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" }, "analysis_type_categories": { "type": "array", "items": { "type": "object", "properties": { "analysis_type_id": { "type": "string", "description": "The ID of the Analysis Type." } } } } }, "required": [ "quick_entry_type_id", "date", "contact_id", "reference", "ledger_account_id" ] } }, "required": [ "purchase_quick_entry" ], "description": "Creates a Purchase Quick Entry" }, "putPurchaseQuickEntries": { "type": "object", "properties": { "purchase_quick_entry": { "type": "object", "properties": { "quick_entry_type_id": { "type": "string", "description": "The type of quick entry e.g. invoice or credit note" }, "date": { "type": "string", "format": "date", "description": "The date of the quick entry" }, "contact_id": { "type": "string", "description": "The contact the quick entry relates to" }, "reference": { "type": "string", "description": "The reference for the quick entry" }, "ledger_account_id": { "type": "string", "description": "The associated ledger account" }, "contact_name": { "type": "string", "description": "The name of the contact when the quick entry was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the quick entry was created" }, "details": { "type": "string", "description": "A description of the quick entry" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the quick entry" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quick entry" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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_total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "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" }, "analysis_type_categories": { "type": "array", "items": { "type": "object", "properties": { "analysis_type_id": { "type": "string", "description": "The ID of the Analysis Type." } } } } } } }, "required": [ "purchase_quick_entry" ], "description": "Updates a Purchase Quick Entry" }, "SalesCorrectiveInvoice": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "tax_calculation_method": { "type": "string", "description": "The tax calculation method, if applicable, for this sales invoice, returns invoice, cash or retailer." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "destination_vat_rates_in_use": { "type": "boolean", "description": "Indicates whether destination vat rates are in use" }, "transaction": { "$ref": "#/components/schemas/Transaction" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "contact": { "$ref": "#/components/schemas/Contact" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "invoice_number_prefix": { "type": "string", "maxLength": 6, "description": "The invoice number prefix" }, "invoice_number": { "type": "string", "description": "The generated invoice number" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the invoice" }, "main_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form main address of the invoice\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "main_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "delivery_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form delivery address of the invoice\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "delivery_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "notes": { "type": "string", "maxLength": 2000, "description": "Invoice notes" }, "terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "Invoice terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate": { "$ref": "#/components/schemas/Base" }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the invoice" }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the invoice including any payments, allocations and discounts" }, "outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the invoice in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "base_currency_outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice in base currency" }, "status": { "$ref": "#/components/schemas/Base" }, "sent": { "type": "boolean", "description": "Indicates whether the invoice has been sent" }, "sent_by_email": { "type": "boolean", "description": "Indicates whether the invoice has been emailed" }, "void_reason": { "type": "string", "maxLength": 200, "description": "The reason the invoice was voided" }, "invoice_lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceLineItem" }, "description": "The invoice lines of the invoice" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The invoice tax analysis" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "last_paid": { "type": "string", "format": "date", "description": "The date of the last payment" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Amount (Spain only) in the base currency" }, "corrective_reason_code": { "$ref": "#/components/schemas/Base" }, "original_invoice": { "$ref": "#/components/schemas/Generic" }, "original_invoice_number": { "type": "string", "description": "The number relating to the original invoice" }, "original_invoice_date": { "type": "string", "description": "The Invoice date relating to the original invoice" }, "details": { "type": "string", "description": "The corrective invoice details" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the artefact is tax reconciled or not." } }, "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 `Sales`: Full Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "SalesArtefactAddress": { "type": "object", "properties": { "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", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "address_type": { "$ref": "#/components/schemas/Base" }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group": { "$ref": "#/components/schemas/Base" } } }, "SalesInvoiceLineItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "description": { "type": "string", "description": "The description for the invoice line" }, "product": { "$ref": "#/components/schemas/Product" }, "service": { "$ref": "#/components/schemas/Service" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the invoice line" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type": { "$ref": "#/components/schemas/Base" }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description": { "$ref": "#/components/schemas/EuSalesDescription" } } }, "EuSalesDescription": { "type": "object", "properties": { "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": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "postSalesCorrectiveInvoices": { "type": "object", "properties": { "sales_corrective_invoice": { "type": "object", "properties": { "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "invoice_number_prefix": { "type": "string", "description": "The invoice number prefix" }, "invoice_number": { "type": "string", "description": "The generated invoice number" }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "terms_and_conditions": { "type": "string", "description": "Invoice terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the invoice has been sent" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Amount (Spain only) in the base currency" }, "corrective_reason_code_id": { "type": "string", "description": "The ID of the Corrective Reason Code." }, "original_invoice_id": { "type": "string", "description": "The ID of the Original Invoice. (Spain only)" }, "original_invoice_number": { "type": "string", "description": "The number relating to the original invoice" }, "original_invoice_date": { "type": "string", "description": "The Invoice date relating to the original invoice" }, "details": { "type": "string", "description": "The corrective invoice details" }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "invoice_lines": { "type": "array", "items": { "type": "object", "properties": { "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "description": { "type": "string", "description": "The description for the invoice line" }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "sales_corrective_invoice" ], "description": "Creates a Sales Corrective Invoice" }, "putSalesCorrectiveInvoices": { "type": "object", "properties": { "sales_corrective_invoice": { "type": "object", "properties": { "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "invoice_number_prefix": { "type": "string", "description": "The invoice number prefix" }, "invoice_number": { "type": "string", "description": "The generated invoice number" }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "terms_and_conditions": { "type": "string", "description": "Invoice terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the invoice has been sent" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF Witheld Tax Amount (Spain only) in the base currency" }, "corrective_reason_code_id": { "type": "string", "description": "The ID of the Corrective Reason Code." }, "original_invoice_id": { "type": "string", "description": "The ID of the Original Invoice. (Spain only)" }, "original_invoice_number": { "type": "string", "description": "The number relating to the original invoice" }, "original_invoice_date": { "type": "string", "description": "The Invoice date relating to the original invoice" }, "details": { "type": "string", "description": "The corrective invoice details" }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "invoice_lines": { "type": "array", "items": { "type": "object", "properties": { "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "description": { "type": "string", "description": "The description for the invoice line" }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "sales_corrective_invoice" ], "description": "Updates a Sales Corrective Invoice" }, "SalesCreditNote": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "tax_calculation_method": { "type": "string", "description": "The tax calculation method, if applicable, for this sales credit note, returns invoice or cash." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "destination_vat_rates_in_use": { "type": "boolean", "description": "Indicates whether destination vat rates are in use" }, "transaction": { "$ref": "#/components/schemas/Transaction" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "is_cis": { "type": "boolean", "description": "Identifies an artefact as CIS (Construction Industry Scheme) applicable - UK only" }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "has_cis_labour": { "type": "boolean", "description": "Identifies an artefact as having CIS Labour line items" }, "has_cis_materials": { "type": "boolean", "description": "Identifies an artefact as having CIS Materials line items" }, "contact": { "$ref": "#/components/schemas/Contact" }, "credit_note_number_prefix": { "type": "string", "maxLength": 6, "description": "The credit note number prefix" }, "credit_note_number": { "type": "string", "description": "The generated credit note number" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the credit note was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the credit note was created" }, "date": { "type": "string", "format": "date", "description": "The date of the credit note" }, "original_invoice_date": { "type": "string", "format": "date", "description": "The date of the original invoice" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the credit note" }, "main_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form main address of the credit note\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "main_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "delivery_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form delivery address of the credit note\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "delivery_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "notes": { "type": "string", "maxLength": 2000, "description": "credit note notes" }, "terms_and_conditions": { "type": "string", "maxLength": 65535, "description": "Credit note terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate": { "$ref": "#/components/schemas/Base" }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the credit note" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the credit note" }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the credit note including any payments, allocations and discounts" }, "outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the credit note" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the credit note" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the credit note" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the credit note in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the credit note" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the credit note in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note in base currency" }, "base_currency_outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the credit note in base currency" }, "status": { "$ref": "#/components/schemas/Base" }, "sent": { "type": "boolean", "description": "Indicates whether the credit note has been sent" }, "sent_by_email": { "type": "boolean", "description": "Indicates whether the credit note has been emailed" }, "void_reason": { "type": "string", "maxLength": 200, "description": "The reason the credit note was voided" }, "credit_note_lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCreditNoteLineItem" }, "description": "The credit note lines of the credit note" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The credit note tax analysis" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "last_paid": { "type": "string", "format": "date", "description": "The date of the last payment" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the sales credit note is tax reconciled or not." }, "migrated": { "type": "boolean", "description": "Indicates if the sales credit note was migrated from another system." }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax)" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "SalesCreditNoteLineItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "description": { "type": "string", "description": "The description for the invoice line" }, "product": { "$ref": "#/components/schemas/Product" }, "service": { "$ref": "#/components/schemas/Service" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the invoice line" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type": { "$ref": "#/components/schemas/Base" }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description": { "$ref": "#/components/schemas/EuSalesDescription" } } }, "postSalesCreditNotes": { "type": "object", "properties": { "sales_credit_note": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the sales credit note relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the credit note" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "credit_note_number_prefix": { "type": "string", "description": "The credit note number prefix" }, "credit_note_number": { "type": "string", "description": "The generated credit note number" }, "contact_name": { "type": "string", "description": "The name of the contact when the credit note was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the credit note was created" }, "original_invoice_date": { "type": "string", "format": "date", "description": "The date of the original invoice" }, "reference": { "type": "string", "description": "The reference for the credit note" }, "notes": { "type": "string", "description": "credit note notes" }, "terms_and_conditions": { "type": "string", "description": "Credit note terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the credit note" }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the credit note" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the credit note" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the credit note" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the credit note in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the credit note has been sent" }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax)" }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "credit_note_lines": { "type": "array", "description": "The credit note lines of the credit note", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the invoice line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } }, "required": [ "description", "ledger_account_id", "unit_price" ] } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } }, "required": [ "contact_id", "date", "credit_note_lines" ] } }, "required": [ "sales_credit_note" ], "description": "Creates a Sales Credit Note" }, "putSalesCreditNotes": { "type": "object", "properties": { "sales_credit_note": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the sales credit note relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the credit note" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "credit_note_number_prefix": { "type": "string", "description": "The credit note number prefix" }, "credit_note_number": { "type": "string", "description": "The generated credit note number" }, "contact_name": { "type": "string", "description": "The name of the contact when the credit note was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the credit note was created" }, "original_invoice_date": { "type": "string", "format": "date", "description": "The date of the original invoice" }, "reference": { "type": "string", "description": "The reference for the credit note" }, "notes": { "type": "string", "description": "credit note notes" }, "terms_and_conditions": { "type": "string", "description": "Credit note terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the credit note" }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the credit note" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the credit note" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the credit note" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the credit note in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the credit note in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the credit note in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the credit note in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the credit note has been sent" }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax)" }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "credit_note_lines": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the invoice line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "sales_credit_note" ], "description": "Updates a Sales Credit Note" }, "SalesEstimate": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "tax_calculation_method": { "type": "string", "description": "The tax calculation method, if applicable, for this sales invoice, returns invoice, cash or retailer." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "destination_vat_rates_in_use": { "type": "boolean", "description": "Indicates whether destination vat rates are in use" }, "contact": { "$ref": "#/components/schemas/Contact" }, "estimate_number_prefix": { "type": "string", "maxLength": 6, "description": "The estimate number prefix" }, "estimate_number": { "type": "string", "description": "The generated estimate number" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the estimate was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the estimate was created" }, "date": { "type": "string", "format": "date", "description": "The date of the estimate" }, "expiry_date": { "type": "string", "format": "date", "description": "The expiry date of the estimate" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the estimate" }, "main_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form main address of the estimate\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "main_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "delivery_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form delivery address of the estimate\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "delivery_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "notes": { "type": "string", "maxLength": 2000, "description": "Estimate notes" }, "terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "Estimate terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate": { "$ref": "#/components/schemas/Base" }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the estimate" }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the estimate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the estimate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the estimate" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the estimate" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the estimate" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the estimate in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the estimate" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the estimate" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the estimate in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the estimate in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the estimate in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the estimate in base currency" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the estimate including any payments, allocations and discounts" }, "status": { "$ref": "#/components/schemas/QuoteStatus" }, "sent": { "type": "boolean", "description": "Indicates whether the estimate has been sent" }, "sent_by_email": { "type": "boolean", "description": "Indicates whether the estimate has been emailed" }, "estimate_lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteLineItem" }, "description": "The estimate lines of the estimate" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The estimate tax analysis" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "profit_analysis": { "$ref": "#/components/schemas/ProfitAnalysis" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the quote/estimate is tax reconciled or not." }, "invoice": { "$ref": "#/components/schemas/Generic" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡บ๐Ÿ‡ธ\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "QuoteStatus": { "type": "object", "properties": { "id": { "type": "string", "description": "The quote status id" }, "displayed_as": { "type": "string", "description": "The quote status name" } } }, "SalesQuoteLineItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "description": { "type": "string", "description": "The description for the quote line" }, "product": { "$ref": "#/components/schemas/Product" }, "service": { "$ref": "#/components/schemas/Service" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the quote line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the quote line" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line in base currency" }, "base_currency_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the quote line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line in base currency" }, "eu_goods_services_type": { "$ref": "#/components/schemas/Base" }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the quote line" }, "eu_sales_description": { "$ref": "#/components/schemas/EuSalesDescription" } } }, "ProfitAnalysis": { "type": "object", "properties": { "total": { "$ref": "#/components/schemas/ProfitBreakdown" }, "line_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/ProfitBreakdown" }, "description": "The breakdown of profit per line" } } }, "ProfitBreakdown": { "type": "object", "properties": { "description": { "type": "string", "description": "The description" }, "total_cost": { "type": "number", "format": "double", "description": "The total cost" }, "total_sale": { "type": "number", "format": "double", "description": "The total sale" }, "profit": { "type": "number", "format": "double", "description": "The profit amount" }, "profit_percentage": { "type": "number", "format": "double", "description": "The profit percentage" } } }, "postSalesEstimates": { "type": "object", "properties": { "sales_estimate": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the estimate relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the estimate" }, "expiry_date": { "type": "string", "format": "date", "description": "The expiry date of the estimate" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "estimate_number_prefix": { "type": "string", "description": "The estimate number prefix" }, "estimate_number": { "type": "string", "description": "The generated estimate number" }, "contact_name": { "type": "string", "description": "The name of the contact when the estimate was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the estimate was created" }, "reference": { "type": "string", "description": "The reference for the estimate" }, "notes": { "type": "string", "description": "Estimate notes" }, "terms_and_conditions": { "type": "string", "description": "Estimate terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the estimate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the estimate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the estimate" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the estimate" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the estimate" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the estimate" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the estimate" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the estimate in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the estimate in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the estimate in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the estimate in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the estimate has been sent" }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "invoice_id": { "type": "string", "description": "The ID of the Invoice." }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "estimate_lines": { "type": "array", "description": "The estimate lines of the estimate", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the quote line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the quote line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the quote line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } }, "required": [ "description", "ledger_account_id", "quantity", "unit_price" ] } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } }, "required": [ "contact_id", "date", "expiry_date", "estimate_lines" ] } }, "required": [ "sales_estimate" ], "description": "Creates a Sales Estimate" }, "putSalesEstimates": { "type": "object", "properties": { "sales_estimate": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the estimate relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the estimate" }, "expiry_date": { "type": "string", "format": "date", "description": "The expiry date of the estimate" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "estimate_number_prefix": { "type": "string", "description": "The estimate number prefix" }, "estimate_number": { "type": "string", "description": "The generated estimate number" }, "contact_name": { "type": "string", "description": "The name of the contact when the estimate was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the estimate was created" }, "reference": { "type": "string", "description": "The reference for the estimate" }, "notes": { "type": "string", "description": "Estimate notes" }, "terms_and_conditions": { "type": "string", "description": "Estimate terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the estimate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the estimate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the estimate" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the estimate" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the estimate" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the estimate" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the estimate" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the estimate in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the estimate in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the estimate in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the estimate in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the estimate has been sent" }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "invoice_id": { "type": "string", "description": "The ID of the Invoice." }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "estimate_lines": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the quote line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the quote line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the quote line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "sales_estimate" ], "description": "Updates a Sales Estimate" }, "SalesInvoice": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "tax_calculation_method": { "type": "string", "description": "The tax calculation method, if applicable, for this sales invoice, returns invoice, cash or retailer." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "destination_vat_rates_in_use": { "type": "boolean", "description": "Indicates whether destination vat rates are in use" }, "transaction": { "$ref": "#/components/schemas/Transaction" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "is_cis": { "type": "boolean", "description": "Identifies an artefact as CIS (Construction Industry Scheme) applicable - UK only" }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "has_cis_labour": { "type": "boolean", "description": "Identifies an artefact as having CIS Labour line items" }, "has_cis_materials": { "type": "boolean", "description": "Identifies an artefact as having CIS Materials line items" }, "contact": { "$ref": "#/components/schemas/Contact" }, "recurring_invoice": { "$ref": "#/components/schemas/RecurringSalesInvoice" }, "invoice_number_prefix": { "type": "string", "maxLength": 6, "description": "The invoice number prefix" }, "invoice_number": { "type": "string", "description": "The generated invoice number" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the invoice was created" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the invoice" }, "main_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form main address of the invoice\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "main_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "delivery_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form delivery address of the invoice\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "delivery_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "notes": { "type": "string", "maxLength": 2000, "description": "Invoice notes" }, "terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "Invoice terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate": { "$ref": "#/components/schemas/Base" }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the invoice" }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the invoice including any payments, allocations and discounts" }, "outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the invoice in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "base_currency_outstanding_amount": { "type": "number", "format": "double", "description": "The outstanding amount of the invoice in base currency" }, "status": { "$ref": "#/components/schemas/Base" }, "sent": { "type": "boolean", "description": "Indicates whether the invoice has been sent" }, "sent_by_email": { "type": "boolean", "description": "Indicates whether the invoice has been emailed" }, "void_reason": { "type": "string", "maxLength": 200, "description": "The reason the invoice was voided" }, "invoice_lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceLineItem" }, "description": "The invoice lines of the invoice" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The invoice tax analysis" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "last_paid": { "type": "string", "format": "date", "description": "The date of the last payment" }, "original_quote_estimate": { "$ref": "#/components/schemas/SalesInvoiceQuoteEstimate" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "delivery_performance_date": { "type": "string", "maxLength": 40, "description": "Delivery/Performance Date (Germany only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate) and Spain (IRPF)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "corrections": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCorrectiveInvoice" }, "description": "The corrective entries associated with the invoice" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the sales invoice is tax reconciled or not." }, "migrated": { "type": "boolean", "description": "Indicates if the sales invoice was migrated from another system." } }, "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 `Sales`: Full Access, Restricted Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "RecurringSalesInvoice": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "frequency": { "type": "integer", "format": "int32", "description": "The invoice recurrence frequency" }, "on_week_day": { "type": "integer", "format": "int32", "description": "The invoice recurrence week day" }, "on_day_number": { "type": "integer", "format": "int32", "description": "The invoice recurrence day" }, "recurrence_type": { "type": "string", "description": "The invoice recurrence type" }, "recurrence_status_identifier": { "type": "string", "description": "The status of the recurrence" } } }, "SalesInvoiceQuoteEstimate": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" } } }, "postSalesInvoices": { "type": "object", "properties": { "sales_invoice": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the sales invoice relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "invoice_number_prefix": { "type": "string", "description": "The invoice number prefix" }, "invoice_number": { "type": "string", "description": "The generated invoice number" }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "terms_and_conditions": { "type": "string", "description": "Invoice terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the invoice has been sent" }, "original_quote_estimate_id": { "type": "string", "description": "The ID of the Original Quote Estimate." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "delivery_performance_date": { "type": "string", "description": "Delivery/Performance Date (Germany only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate) and Spain (IRPF)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "recurring_invoice": { "type": "object", "properties": { "frequency": { "type": "integer", "format": "int32", "description": "The invoice recurrence frequency" }, "on_week_day": { "type": "integer", "format": "int32", "description": "The invoice recurrence week day" }, "on_day_number": { "type": "integer", "format": "int32", "description": "The invoice recurrence day" }, "recurrence_type": { "type": "string", "description": "The invoice recurrence type" }, "recurrence_status_identifier": { "type": "string", "description": "The status of the recurrence" } } }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "invoice_lines": { "type": "array", "description": "The invoice lines of the invoice", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the invoice line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } }, "required": [ "description", "ledger_account_id", "unit_price" ] } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } }, "required": [ "contact_id", "date", "invoice_lines" ] } }, "required": [ "sales_invoice" ], "description": "Creates a Sales Invoice" }, "putSalesInvoices": { "type": "object", "properties": { "sales_invoice": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the sales invoice relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the invoice" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour - only applicable in UK" }, "base_currency_cis_applicable_amount": { "type": "number", "format": "double", "description": "The total amount of CIS deductible labour in the base currency - only applicable in UK" }, "total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted - only applicable in UK" }, "base_currency_total_after_cis_deduction": { "type": "number", "format": "double", "description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK" }, "invoice_number_prefix": { "type": "string", "description": "The invoice number prefix" }, "invoice_number": { "type": "string", "description": "The generated invoice number" }, "contact_name": { "type": "string", "description": "The name of the contact when the invoice was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the invoice was created" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the invoice" }, "reference": { "type": "string", "description": "The reference for the invoice" }, "notes": { "type": "string", "description": "Invoice notes" }, "terms_and_conditions": { "type": "string", "description": "Invoice terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the invoice" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the invoice" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the invoice" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the invoice in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the invoice in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the invoice in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the invoice in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the invoice has been sent" }, "original_quote_estimate_id": { "type": "string", "description": "The ID of the Original Quote Estimate." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "delivery_performance_date": { "type": "string", "description": "Delivery/Performance Date (Germany only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate) and Spain (IRPF)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax) and Spain (IRPF)" }, "recurring_invoice": { "type": "object", "properties": { "frequency": { "type": "integer", "format": "int32", "description": "The invoice recurrence frequency" }, "on_week_day": { "type": "integer", "format": "int32", "description": "The invoice recurrence week day" }, "on_day_number": { "type": "integer", "format": "int32", "description": "The invoice recurrence day" }, "recurrence_type": { "type": "string", "description": "The invoice recurrence type" }, "recurrence_status_identifier": { "type": "string", "description": "The status of the recurrence" } } }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "invoice_lines": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the invoice line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the invoice line" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the invoice line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the invoice line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the invoice line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the invoice line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the invoice line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the invoice line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "sales_invoice" ], "description": "Updates a Sales Invoice" }, "QuickEntry": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "quick_entry_type": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "date": { "type": "string", "format": "date", "description": "The date of the quick entry" }, "due_date": { "type": "string", "format": "date", "description": "The due date of the quick entry" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the quick entry" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quick entry" }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "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": { "$ref": "#/components/schemas/Base" }, "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": { "$ref": "#/components/schemas/TaxBreakdown" }, "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": { "$ref": "#/components/schemas/Base" }, "payments_allocations": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAllocation" }, "description": "The associated payments and allocations" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "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." } }, "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 `Sales`: Full Access, Restricted Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "postSalesQuickEntries": { "type": "object", "properties": { "sales_quick_entry": { "type": "object", "properties": { "quick_entry_type_id": { "type": "string", "description": "The type of quick entry e.g. invoice or credit note" }, "date": { "type": "string", "format": "date", "description": "The date of the quick entry" }, "contact_id": { "type": "string", "description": "The contact the quick entry relates to" }, "reference": { "type": "string", "description": "The reference for the quick entry" }, "ledger_account_id": { "type": "string", "description": "The associated ledger account" }, "contact_name": { "type": "string", "description": "The name of the contact when the quick entry was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the quick entry was created" }, "details": { "type": "string", "description": "A description of the quick entry" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the quick entry" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quick entry" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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_total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "trade_of_asset": { "type": "boolean", "description": "Whether the quick entry is marked as trade of asset." }, "analysis_type_categories": { "type": "array", "items": { "type": "object", "properties": { "analysis_type_id": { "type": "string", "description": "The ID of the Analysis Type." } } } } }, "required": [ "quick_entry_type_id", "date", "contact_id", "reference", "ledger_account_id" ] } }, "required": [ "sales_quick_entry" ], "description": "Creates a Sales Quick Entry" }, "putSalesQuickEntries": { "type": "object", "properties": { "sales_quick_entry": { "type": "object", "properties": { "quick_entry_type_id": { "type": "string", "description": "The type of quick entry e.g. invoice or credit note" }, "date": { "type": "string", "format": "date", "description": "The date of the quick entry" }, "contact_id": { "type": "string", "description": "The contact the quick entry relates to" }, "reference": { "type": "string", "description": "The reference for the quick entry" }, "ledger_account_id": { "type": "string", "description": "The associated ledger account" }, "contact_name": { "type": "string", "description": "The name of the contact when the quick entry was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the quick entry was created" }, "details": { "type": "string", "description": "A description of the quick entry" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the quick entry" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quick entry" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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_total_amount": { "type": "number", "format": "double", "description": "The total amount of the quick entry in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "trade_of_asset": { "type": "boolean", "description": "Whether the quick entry is marked as trade of asset." }, "analysis_type_categories": { "type": "array", "items": { "type": "object", "properties": { "analysis_type_id": { "type": "string", "description": "The ID of the Analysis Type." } } } } } } }, "required": [ "sales_quick_entry" ], "description": "Updates a Sales Quick Entry" }, "SalesQuote": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" }, "editable": { "type": "boolean", "description": "Indicates whether artefact can be edited" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "tax_calculation_method": { "type": "string", "description": "The tax calculation method, if applicable, for this sales invoice, returns invoice, cash or retailer." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "destination_vat_rates_in_use": { "type": "boolean", "description": "Indicates whether destination vat rates are in use" }, "contact": { "$ref": "#/components/schemas/Contact" }, "quote_number_prefix": { "type": "string", "maxLength": 6, "description": "The quote number prefix" }, "quote_number": { "type": "string", "description": "The generated quote number" }, "contact_name": { "type": "string", "maxLength": 255, "description": "The name of the contact when the quote was created" }, "contact_reference": { "type": "string", "maxLength": 255, "description": "The reference of the contact when the quote was created" }, "date": { "type": "string", "format": "date", "description": "The date of the quote" }, "expiry_date": { "type": "string", "format": "date", "description": "The expiry date of the quote" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the quote" }, "main_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form main address of the quote\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "main_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "delivery_address_free_form": { "type": "string", "maxLength": 500, "description": "The free-form delivery address of the quote\nNote: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though." }, "delivery_address": { "$ref": "#/components/schemas/SalesArtefactAddress" }, "notes": { "type": "string", "maxLength": 2000, "description": "Quote notes" }, "terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "Quote terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate": { "$ref": "#/components/schemas/Base" }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the quote" }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the quote" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quote" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the quote" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the quote" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the quote" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The shipping tax breakdown for the quote in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the quote" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the quote" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the quote in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the quote in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quote in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the quote in base currency" }, "payments_allocations_total_amount": { "type": "number", "format": "double", "description": "The total amount of all payments and allocations" }, "payments_allocations_total_discount": { "type": "number", "format": "double", "description": "The total discount of all payments and allocations" }, "total_paid": { "type": "number", "format": "double", "description": "The total paid amount of the quote including any payments, allocations and discounts" }, "status": { "$ref": "#/components/schemas/QuoteStatus" }, "sent": { "type": "boolean", "description": "Indicates whether the quote has been sent" }, "sent_by_email": { "type": "boolean", "description": "Indicates whether the quote has been emailed" }, "quote_lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuoteLineItem" }, "description": "The quote lines of the quote" }, "tax_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/ArtefactTaxAnalysis" }, "description": "The quote tax analysis" }, "detailed_tax_analysis": { "$ref": "#/components/schemas/ArtefactDetailedTaxAnalysis" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "profit_analysis": { "$ref": "#/components/schemas/ProfitAnalysis" }, "tax_reconciled": { "type": "boolean", "description": "Indicates if the quote/estimate is tax reconciled or not." }, "invoice": { "$ref": "#/components/schemas/Generic" } }, "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 `Sales`: Full Access, Restricted Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "postSalesQuotes": { "type": "object", "properties": { "sales_quote": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the quote relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the quote" }, "expiry_date": { "type": "string", "format": "date", "description": "The expiry date of the quote" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "quote_number_prefix": { "type": "string", "description": "The quote number prefix" }, "quote_number": { "type": "string", "description": "The generated quote number" }, "contact_name": { "type": "string", "description": "The name of the contact when the quote was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the quote was created" }, "reference": { "type": "string", "description": "The reference for the quote" }, "notes": { "type": "string", "description": "Quote notes" }, "terms_and_conditions": { "type": "string", "description": "Quote terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the quote" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quote" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the quote" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the quote" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the quote" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the quote" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the quote" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the quote in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the quote in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quote in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the quote in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the quote has been sent" }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "invoice_id": { "type": "string", "description": "The ID of the Invoice." }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "quote_lines": { "type": "array", "description": "The quote lines of the quote", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the quote line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the quote line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the quote line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } }, "required": [ "description", "ledger_account_id", "quantity", "unit_price" ] } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } }, "required": [ "contact_id", "date", "expiry_date", "quote_lines" ] } }, "required": [ "sales_quote" ], "description": "Creates a Sales Quote" }, "putSalesQuotes": { "type": "object", "properties": { "sales_quote": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "The contact the quote relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the quote" }, "expiry_date": { "type": "string", "format": "date", "description": "The expiry date of the quote" }, "vat_reverse_charge": { "type": "boolean", "description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business." }, "destination_consignment": { "type": "boolean", "description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings." }, "quote_number_prefix": { "type": "string", "description": "The quote number prefix" }, "quote_number": { "type": "string", "description": "The generated quote number" }, "contact_name": { "type": "string", "description": "The name of the contact when the quote was created" }, "contact_reference": { "type": "string", "description": "The reference of the contact when the quote was created" }, "reference": { "type": "string", "description": "The reference for the quote" }, "notes": { "type": "string", "description": "Quote notes" }, "terms_and_conditions": { "type": "string", "description": "Quote terms and conditions" }, "shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount" }, "shipping_tax_rate_id": { "type": "string", "description": "The ID of the Shipping Tax Rate." }, "shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate." }, "shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the quote" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quote" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the quote" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the quote" }, "inverse_exchange_rate": { "type": "number", "format": "double", "description": "The inverse exchange rate for the quote" }, "base_currency_shipping_net_amount": { "type": "number", "format": "double", "description": "The net shipping amount in base currency" }, "base_currency_shipping_tax_amount": { "type": "number", "format": "double", "description": "The tax shipping amount in base currency" }, "base_currency_shipping_total_amount": { "type": "number", "format": "double", "description": "The total shipping amount in base currency" }, "total_quantity": { "type": "number", "format": "double", "description": "The total quantity of the quote" }, "total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the quote" }, "base_currency_total_discount_amount": { "type": "number", "format": "double", "description": "The discount amount on the quote in base currency" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the quote in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the quote in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the quote in base currency" }, "status_id": { "type": "string", "description": "The ID of the Status." }, "sent": { "type": "boolean", "description": "Indicates whether the quote has been sent" }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld Tax Rate (Spain only)" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only)" }, "base_currency_withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld Tax Amount (Spain only) in the base currency" }, "invoice_id": { "type": "string", "description": "The ID of the Invoice." }, "main_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "delivery_address": { "type": "object", "properties": { "address_line_1": { "type": "string", "description": "The first line of the address" }, "address_line_2": { "type": "string", "description": "The second line of the address" }, "city": { "type": "string", "description": "The address town/city" }, "postal_code": { "type": "string", "description": "The address postal code/zipcode" }, "country_id": { "type": "string", "description": "The ID of the Country." }, "address_type_id": { "type": "string", "description": "The ID of the Address Type." }, "region": { "type": "string", "description": "The address state/province/region" }, "country_group_id": { "type": "string", "description": "The ID of the Country Group." } } }, "quote_lines": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description for the quote line" }, "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "quantity": { "type": "number", "format": "double", "description": "The quantity for the quote line" }, "unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "product_id": { "type": "string", "description": "The ID of the Product." }, "service_id": { "type": "string", "description": "The ID of the Service." }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line" }, "base_currency_unit_price": { "type": "number", "format": "double", "description": "The unit price for the quote line in base currency" }, "unit_price_includes_tax": { "type": "boolean", "description": "Defines whether the unit price includes tax" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount for the quote line in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the quote line in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount for the quote line in base currency" }, "eu_goods_services_type_id": { "type": "string", "description": "The ID of the EU Goods Services Type." }, "discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line" }, "base_currency_discount_amount": { "type": "number", "format": "double", "description": "The discount amount for the quote line in base currency" }, "discount_percentage": { "type": "number", "format": "double", "description": "The discount percentage for the quote line" }, "eu_sales_description_id": { "type": "string", "description": "The ID of the EU Sales Description. Only applies to transactions being sold to or purchased from a VAT registered Northern Irish Business" } } } }, "tax_analysis": { "type": "array", "items": { "type": "object", "properties": { "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount for the tax rate" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount for the tax rate" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate" }, "goods_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to goods" }, "service_amount": { "type": "number", "format": "double", "description": "The total amount for the tax rate relating to services" } } } } } } }, "required": [ "sales_quote" ], "description": "Updates a Sales Quote" }, "HostedArtefactPaymentSetting": { "type": "object", "properties": { "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" }, "object_guid": { "type": "string", "maxLength": 32, "description": "The sageone_guid of the object you are disabling card payments for." }, "disable_payment": { "type": "boolean", "description": "The flag to disable online payments." } }, "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 `Sales`: Full Access, Restricted Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "postHostedArtefactPaymentSettings": { "type": "object", "properties": { "hosted_artefact_payment_setting": { "type": "object", "properties": { "object_guid": { "type": "string", "description": "The sageone_guid of the object you are disabling card payments for." }, "disable_payment": { "type": "boolean", "description": "The flag to disable online payments." } } } }, "required": [ "hosted_artefact_payment_setting" ], "description": "Creates a Hosted Artefact Payment Setting" }, "ContactOpeningBalance": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "contact_opening_balance_type": { "$ref": "#/components/schemas/Base" }, "contact": { "$ref": "#/components/schemas/Base" }, "date": { "type": "string", "format": "date", "description": "The date of the opening balance" }, "reference": { "type": "string", "maxLength": 25, "description": "The reference for the opening balance" }, "details": { "type": "string", "maxLength": 255, "description": "A description of the opening balance" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the opening balance" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the opening balance" }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the opening balance" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the opening balance" }, "currency": { "$ref": "#/components/schemas/Base" }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the opening balance" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the opening balance in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the opening balance in base currency" }, "base_currency_tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the opening balance in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the opening balance in base currency" } }, "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 areas `Settings`, `Sales`, and `Purchases`: Full Access", "x-sage-menusection": "Settings" }, "postContactOpeningBalances": { "type": "object", "properties": { "contact_opening_balance": { "type": "object", "properties": { "contact_opening_balance_type_id": { "type": "string", "description": "The type of contact opening balance e.g. invoice or credit note" }, "date": { "type": "string", "format": "date", "description": "The date of the opening balance" }, "contact_id": { "type": "string", "description": "The contact the opening balance relates to" }, "reference": { "type": "string", "description": "The reference for the opening balance" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the opening balance" }, "transaction_type_id": { "type": "string", "description": "The ID of the Transaction Type." }, "details": { "type": "string", "description": "A description of the opening balance" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the opening balance" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the opening balance" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the opening balance" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the opening balance in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the opening balance in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the opening balance in base currency" } }, "required": [ "contact_opening_balance_type_id", "date", "contact_id", "reference", "total_amount" ] } }, "required": [ "contact_opening_balance" ], "description": "Creates a Contact Opening Balance" }, "putContactOpeningBalances": { "type": "object", "properties": { "contact_opening_balance": { "type": "object", "properties": { "contact_opening_balance_type_id": { "type": "string", "description": "The type of contact opening balance e.g. invoice or credit note" }, "date": { "type": "string", "format": "date", "description": "The date of the opening balance" }, "contact_id": { "type": "string", "description": "The contact the opening balance relates to" }, "reference": { "type": "string", "description": "The reference for the opening balance" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the opening balance" }, "transaction_type_id": { "type": "string", "description": "The ID of the Transaction Type." }, "details": { "type": "string", "description": "A description of the opening balance" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the opening balance" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the opening balance" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "exchange_rate": { "type": "number", "format": "double", "description": "The exchange rate for the opening balance" }, "base_currency_net_amount": { "type": "number", "format": "double", "description": "The net amount of the opening balance in base currency" }, "base_currency_tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the opening balance in base currency" }, "base_currency_total_amount": { "type": "number", "format": "double", "description": "The total amount of the opening balance in base currency" } } } }, "required": [ "contact_opening_balance" ], "description": "Updates a Contact Opening Balance" }, "BankOpeningBalance": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "bank_account": { "$ref": "#/components/schemas/Base" }, "date": { "type": "string", "format": "date", "description": "The date of the opening balance" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the opening balance" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the opening balance" } }, "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 areas `Settings` and `Bank`: Full Access", "x-sage-menusection": "Settings" }, "postBankOpeningBalances": { "type": "object", "properties": { "bank_opening_balance": { "type": "object", "properties": { "bank_account_id": { "type": "string", "description": "The bank account the opening balance relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the opening balance" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the opening balance" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the opening balance" }, "transaction_type_id": { "type": "string", "description": "The ID of the Transaction Type." } }, "required": [ "bank_account_id", "date", "debit", "credit" ] } }, "required": [ "bank_opening_balance" ], "description": "Creates a Bank Opening Balance" }, "putBankOpeningBalances": { "type": "object", "properties": { "bank_opening_balance": { "type": "object", "properties": { "bank_account_id": { "type": "string", "description": "The bank account the opening balance relates to" }, "date": { "type": "string", "format": "date", "description": "The date of the opening balance" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the opening balance" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the opening balance" }, "transaction_type_id": { "type": "string", "description": "The ID of the Transaction Type." } } } }, "required": [ "bank_opening_balance" ], "description": "Updates a Bank Opening Balance" }, "LedgerAccountOpeningBalance": { "type": "object", "properties": { "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" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "details": { "type": "string", "maxLength": 255, "description": "A description of the opening balance" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the opening balance" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the opening balance" } }, "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory Reporting`, `Products & Services`, and `Reporting`: Full Access", "x-sage-menusection": "Settings" }, "postLedgerAccountOpeningBalances": { "type": "object", "properties": { "ledger_account_opening_balance": { "type": "object", "properties": { "ledger_account_id": { "type": "string", "description": "The ledger account the opening balance relates to" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the opening balance" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the opening balance" }, "details": { "type": "string", "description": "A description of the opening balance" } }, "required": [ "ledger_account_id", "debit", "credit" ] } }, "required": [ "ledger_account_opening_balance" ], "description": "Creates a Ledger Account Opening Balance" }, "putLedgerAccountOpeningBalances": { "type": "object", "properties": { "ledger_account_opening_balance": { "type": "object", "properties": { "ledger_account_id": { "type": "string", "description": "The ledger account the opening balance relates to" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the opening balance" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the opening balance" }, "details": { "type": "string", "description": "A description of the opening balance" } } } }, "required": [ "ledger_account_opening_balance" ], "description": "Updates a Ledger Account Opening Balance" }, "OpeningBalanceJournal": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "date": { "type": "string", "format": "date", "description": "The date of the opening balance journal" }, "reference": { "type": "string", "maxLength": 25, "description": "A reference for the opening balance journal" }, "journal_lines": { "type": "array", "items": { "$ref": "#/components/schemas/BaseJournalLine" }, "description": "The journal lines" } }, "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 areas `Sales`, `Purchases`, `Contacts`, `Journals`, `Settings`, `Bank`, `Statutory Reporting`, `Products & Services`, and `Reporting`: Full Access", "x-sage-menusection": "Settings" }, "BaseJournalLine": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "ledger_account": { "$ref": "#/components/schemas/LedgerAccount" }, "details": { "type": "string", "description": "A description of the journal line" }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the journal line" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the journal line" } } }, "postOpeningBalanceJournals": { "type": "object", "properties": { "opening_balance_journal": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "The date of the opening balance journal" }, "reference": { "type": "string", "description": "A reference for the opening balance journal" }, "journal_lines": { "type": "array", "description": "The journal lines", "items": { "type": "object", "properties": { "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "debit": { "type": "number", "format": "double", "description": "The debit amount of the journal line" }, "credit": { "type": "number", "format": "double", "description": "The credit amount of the journal line" }, "details": { "type": "string", "description": "A description of the journal line" } }, "required": [ "ledger_account_id", "debit", "credit" ] } } }, "required": [ "journal_lines" ] } }, "required": [ "opening_balance_journal" ], "description": "Creates a Opening Balance Journal" }, "postContactAllocations": { "type": "object", "properties": { "contact_allocation": { "type": "object", "properties": { "transaction_type_id": { "type": "string", "description": "The transaction type of the allocation" }, "contact_id": { "type": "string", "description": "The contact that the allocation relates to" }, "date": { "type": "string", "format": "date", "description": "The date the allocation was made" }, "allocated_artefacts": { "type": "array", "description": "The payment lines of the payment", "items": { "type": "object", "properties": { "artefact_id": { "type": "string", "description": "The ID of the Artefact." }, "amount": { "type": "number", "format": "double", "description": "The allocated amount" } } } } }, "required": [ "transaction_type_id", "contact_id", "allocated_artefacts" ] } }, "required": [ "contact_allocation" ], "description": "Creates a Contact Allocation" }, "putContactAllocations": { "type": "object", "properties": { "contact_allocation": { "type": "object", "properties": { "transaction_type_id": { "type": "string", "description": "The transaction type of the allocation" }, "contact_id": { "type": "string", "description": "The contact that the allocation relates to" }, "date": { "type": "string", "format": "date", "description": "The date the allocation was made" }, "allocated_artefacts": { "type": "array", "items": { "type": "object", "properties": { "artefact_id": { "type": "string", "description": "The ID of the Artefact." }, "amount": { "type": "number", "format": "double", "description": "The allocated amount" } } } } } } }, "required": [ "contact_allocation" ], "description": "Updates a Contact Allocation" }, "postContactPayments": { "type": "object", "properties": { "contact_payment": { "type": "object", "properties": { "transaction_type_id": { "type": "string", "description": "The transaction type of the payment" }, "contact_id": { "type": "string", "description": "The contact of the payment" }, "bank_account_id": { "type": "string", "description": "The bank account of the payment" }, "date": { "type": "string", "format": "date", "description": "The date the payment was made" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the payment" }, "payment_method_id": { "type": "string", "description": "The ID of the Payment Method." }, "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" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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", "description": "A reference for the payment" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "allocated_artefacts": { "type": "array", "items": { "type": "object", "properties": { "artefact_id": { "type": "string", "description": "The ID of the Artefact." }, "amount": { "type": "number", "format": "double", "description": "The allocated amount" }, "discount": { "type": "number", "format": "double", "description": "The allocated discount" } } } }, "payment_on_account": { "type": "object", "properties": { "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_id": { "type": "string", "description": "The ID of the Contact." }, "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_id": { "type": "string", "description": "The ID of the Currency." }, "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_id": { "type": "string", "description": "The ID of the Status." } } } }, "required": [ "transaction_type_id", "contact_id", "bank_account_id", "date", "total_amount" ] } }, "required": [ "contact_payment" ], "description": "Creates a Contact Payment" }, "putContactPayments": { "type": "object", "properties": { "contact_payment": { "type": "object", "properties": { "transaction_type_id": { "type": "string", "description": "The transaction type of the payment" }, "contact_id": { "type": "string", "description": "The contact of the payment" }, "bank_account_id": { "type": "string", "description": "The bank account of the payment" }, "date": { "type": "string", "format": "date", "description": "The date the payment was made" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the payment" }, "payment_method_id": { "type": "string", "description": "The ID of the Payment Method." }, "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" }, "currency_id": { "type": "string", "description": "The ID of the Currency." }, "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", "description": "A reference for the payment" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "allocated_artefacts": { "type": "array", "items": { "type": "object", "properties": { "artefact_id": { "type": "string", "description": "The ID of the Artefact." }, "amount": { "type": "number", "format": "double", "description": "The allocated amount" }, "discount": { "type": "number", "format": "double", "description": "The allocated discount" } } } }, "payment_on_account": { "type": "object", "properties": { "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_id": { "type": "string", "description": "The ID of the Contact." }, "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_id": { "type": "string", "description": "The ID of the Currency." }, "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_id": { "type": "string", "description": "The ID of the Status." } } } } } }, "required": [ "contact_payment" ], "description": "Updates a Contact Payment" }, "OtherPayment": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Base" }, "transaction_type": { "$ref": "#/components/schemas/Base" }, "deleted_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was deleted" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n Other Payment (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the Other Payment (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n Other Payment (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the Other Payment (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the Other Payment is part recoverable or not (Canada only)" }, "payment_method": { "$ref": "#/components/schemas/Base" }, "contact": { "$ref": "#/components/schemas/Base" }, "bank_account": { "$ref": "#/components/schemas/Base" }, "tax_address_region": { "$ref": "#/components/schemas/Base" }, "date": { "type": "string", "format": "date", "description": "The date of the payment" }, "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" }, "reference": { "type": "string", "maxLength": 25, "description": "A reference of 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." }, "payment_lines": { "type": "array", "items": { "$ref": "#/components/schemas/OtherPaymentLineItem" }, "description": "The payment lines of the payment" }, "editable": { "type": "boolean", "description": "Indicates whether or not the payment can be edited" }, "deletable": { "type": "boolean", "description": "Indicates whether or not the payment can be deleted" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld tax rate" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld tax amount" } }, "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`: Restricted Access, Full Access", "x-sage-menusection": "Bank, Payments & Receipts" }, "OtherPaymentLineItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "The name of the resource" }, "analysis_type_categories": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTypeLineItem" }, "description": "The analysis types information" }, "ledger_account": { "$ref": "#/components/schemas/Base" }, "details": { "type": "string", "description": "The details of the payment line" }, "tax_rate": { "$ref": "#/components/schemas/Base" }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the payment line" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the payment line" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the payment line" }, "tax_breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdown" }, "description": "The tax breakdown for the payment line" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland only)" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the other payment" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the other payment" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the other payment is tax recoverable or not" } } }, "postOtherPayments": { "type": "object", "properties": { "other_payment": { "type": "object", "properties": { "transaction_type_id": { "type": "string", "description": "The transaction type of the payment" }, "date": { "type": "string", "format": "date", "description": "The date of the payment" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the payment" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n Other Payment (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the Other Payment (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n Other Payment (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the Other Payment (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the Other Payment is part recoverable or not (Canada only)" }, "payment_method_id": { "type": "string", "description": "The ID of the Payment Method." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "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" }, "reference": { "type": "string", "description": "A reference of the payment" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld tax rate" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld tax amount" }, "payment_lines": { "type": "array", "description": "The payment lines of the payment", "items": { "type": "object", "properties": { "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the payment line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "details": { "type": "string", "description": "The details of the payment line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the payment line" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the payment line" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland only)" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the other payment" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the other payment" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the other payment is tax recoverable or not" } }, "required": [ "ledger_account_id", "total_amount" ] } } }, "required": [ "transaction_type_id", "date", "total_amount", "payment_lines" ] } }, "required": [ "other_payment" ], "description": "Creates a Other Payment" }, "putOtherPayments": { "type": "object", "properties": { "other_payment": { "type": "object", "properties": { "transaction_type_id": { "type": "string", "description": "The transaction type of the payment" }, "date": { "type": "string", "format": "date", "description": "The date of the payment" }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the payment" }, "base_currency_total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit in base currency for the\n Other Payment (Canada only)" }, "total_itc_amount": { "type": "number", "format": "double", "description": "The total amount of input tax credit for the Other Payment (Canada only)" }, "base_currency_total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund in base currency for the\n Other Payment (Canada only)" }, "total_itr_amount": { "type": "number", "format": "double", "description": "The total amount of input tax refund for the Other Payment (Canada only)" }, "part_recoverable": { "type": "boolean", "description": "Indicates if the Other Payment is part recoverable or not (Canada only)" }, "payment_method_id": { "type": "string", "description": "The ID of the Payment Method." }, "contact_id": { "type": "string", "description": "The ID of the Contact." }, "bank_account_id": { "type": "string", "description": "The ID of the Bank Account." }, "tax_address_region_id": { "type": "string", "description": "The ID of the Tax Address Region. (Canada only)" }, "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" }, "reference": { "type": "string", "description": "A reference of the payment" }, "withholding_tax_rate": { "type": "number", "format": "double", "description": "IRPF withheld tax rate" }, "withholding_tax_amount": { "type": "number", "format": "double", "description": "IRPF withheld tax amount" }, "payment_lines": { "type": "array", "items": { "type": "object", "properties": { "ledger_account_id": { "type": "string", "description": "The ID of the Ledger Account." }, "total_amount": { "type": "number", "format": "double", "description": "The total amount of the payment line" }, "analysis_type_categories": { "type": "array", "description": "The analysis types information", "items": { "type": "string" } }, "details": { "type": "string", "description": "The details of the payment line" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." }, "net_amount": { "type": "number", "format": "double", "description": "The net amount of the payment line" }, "tax_amount": { "type": "number", "format": "double", "description": "The tax amount of the payment line" }, "is_purchase_for_resale": { "type": "boolean", "description": "Identifies whether the line item is for resale. (Ireland only)" }, "trade_of_asset": { "type": "boolean", "description": "Whether the line item is marked as trade of asset." }, "gst_amount": { "type": "number", "format": "double", "description": "The gst or hst tax amount for the other payment" }, "pst_amount": { "type": "number", "format": "double", "description": "The pst or qst tax amount for the other payment" }, "tax_recoverable": { "type": "boolean", "description": "Indicates if the other payment is tax recoverable or not" } } } } } } }, "required": [ "other_payment" ], "description": "Updates a Other Payment" }, "UnallocatedArtefact": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/Link" }, "description": "Links for the resource" } }, "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 mentioned role in one of the listed areas:\n* Area: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access", "x-sage-menusection": "Invoices, Quotes & Credit Notes" }, "ProductSalesPriceType": { "type": "object", "properties": { "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 product sales price type" }, "active": { "type": "boolean", "description": "Indicates whether the price type is displayed in the application" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "x-sage-menusection": "Products & Services" }, "postProductSalesPriceTypes": { "type": "object", "properties": { "product_sales_price_type": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the product sales price type" }, "active": { "type": "boolean", "description": "Indicates whether the price type is displayed in the application" } }, "required": [ "name", "active" ] } }, "required": [ "product_sales_price_type" ], "description": "Creates a Product Sales Price Type" }, "putProductSalesPriceTypes": { "type": "object", "properties": { "product_sales_price_type": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the product sales price type" }, "active": { "type": "boolean", "description": "Indicates whether the price type is displayed in the application" } } } }, "required": [ "product_sales_price_type" ], "description": "Updates a Product Sales Price Type" }, "postProducts": { "type": "object", "properties": { "product": { "type": "object", "properties": { "description": { "type": "string", "description": "The product description" }, "sales_ledger_account_id": { "type": "string", "description": "The sales ledger account for the product" }, "purchase_ledger_account_id": { "type": "string", "description": "The purchase ledger account for the product" }, "item_code": { "type": "string", "description": "The item code for the product" }, "notes": { "type": "string", "description": "The notes for the product" }, "sales_tax_rate_id": { "type": "string", "description": "The ID of the Sales Tax Rate." }, "usual_supplier_id": { "type": "string", "description": "The ID of the Usual Supplier." }, "purchase_tax_rate_id": { "type": "string", "description": "The ID of the Purchase Tax Rate." }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the product" }, "source_guid": { "type": "string", "description": "Used when importing products from external sources" }, "purchase_description": { "type": "string", "description": "The product purchase description" }, "active": { "type": "boolean", "description": "Indicates whether the product is active" }, "catalog_item_type_id": { "type": "string", "description": "The ID of the Catalog Item Type." }, "sales_prices": { "type": "array", "items": { "type": "object", "properties": { "price_name": { "type": "string", "description": "The name of the product sales price" }, "price": { "type": "number", "format": "double", "description": "The sales price amount" }, "price_includes_tax": { "type": "boolean", "description": "Indicates whether the sales price already includes tax" }, "product_sales_price_type_id": { "type": "string", "description": "The ID of the Product Sales Price Type." } } } } }, "required": [ "description", "sales_ledger_account_id", "purchase_ledger_account_id" ] } }, "required": [ "product" ], "description": "Creates a Product" }, "putProducts": { "type": "object", "properties": { "product": { "type": "object", "properties": { "description": { "type": "string", "description": "The product description" }, "sales_ledger_account_id": { "type": "string", "description": "The sales ledger account for the product" }, "purchase_ledger_account_id": { "type": "string", "description": "The purchase ledger account for the product" }, "item_code": { "type": "string", "description": "The item code for the product" }, "notes": { "type": "string", "description": "The notes for the product" }, "sales_tax_rate_id": { "type": "string", "description": "The ID of the Sales Tax Rate." }, "usual_supplier_id": { "type": "string", "description": "The ID of the Usual Supplier." }, "purchase_tax_rate_id": { "type": "string", "description": "The ID of the Purchase Tax Rate." }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the product" }, "source_guid": { "type": "string", "description": "Used when importing products from external sources" }, "purchase_description": { "type": "string", "description": "The product purchase description" }, "active": { "type": "boolean", "description": "Indicates whether the product is active" }, "catalog_item_type_id": { "type": "string", "description": "The ID of the Catalog Item Type." }, "sales_prices": { "type": "array", "items": { "type": "object", "properties": { "price_name": { "type": "string", "description": "The name of the product sales price" }, "price": { "type": "number", "format": "double", "description": "The sales price amount" }, "price_includes_tax": { "type": "boolean", "description": "Indicates whether the sales price already includes tax" }, "product_sales_price_type_id": { "type": "string", "description": "The ID of the Product Sales Price Type." } } } } } } }, "required": [ "product" ], "description": "Updates a Product" }, "postServices": { "type": "object", "properties": { "service": { "type": "object", "properties": { "description": { "type": "string", "description": "The service description" }, "sales_ledger_account_id": { "type": "string", "description": "The sales ledger account for the service" }, "item_code": { "type": "string", "description": "The item code for the service" }, "notes": { "type": "string", "description": "The notes for the service" }, "purchase_ledger_account_id": { "type": "string", "description": "The ID of the Purchase Ledger Account." }, "sales_tax_rate_id": { "type": "string", "description": "The ID of the Sales Tax Rate." }, "purchase_tax_rate_id": { "type": "string", "description": "The ID of the Purchase Tax Rate." }, "source_guid": { "type": "string", "description": "Used when importing services from external sources" }, "purchase_description": { "type": "string", "description": "The service purchase description" }, "usual_supplier_id": { "type": "string", "description": "The ID of the Usual Supplier." }, "active": { "type": "boolean", "description": "Indicates whether the service is active" }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the service" }, "oss_service": { "type": "boolean", "description": "Indicates whether the service is One Stop Shop" }, "sales_rates": { "type": "array", "items": { "type": "object", "properties": { "rate_name": { "type": "string", "description": "The name of the service rate" }, "rate": { "type": "number", "format": "double", "description": "The rate amount" }, "rate_includes_tax": { "type": "boolean", "description": "Indicates whether the rate already includes tax" }, "service_rate_type_id": { "type": "string", "description": "The ID of the Service Rate Type." } } } } }, "required": [ "description", "sales_ledger_account_id" ] } }, "required": [ "service" ], "description": "Creates a Service" }, "putServices": { "type": "object", "properties": { "service": { "type": "object", "properties": { "description": { "type": "string", "description": "The service description" }, "sales_ledger_account_id": { "type": "string", "description": "The sales ledger account for the service" }, "item_code": { "type": "string", "description": "The item code for the service" }, "notes": { "type": "string", "description": "The notes for the service" }, "purchase_ledger_account_id": { "type": "string", "description": "The ID of the Purchase Ledger Account." }, "sales_tax_rate_id": { "type": "string", "description": "The ID of the Sales Tax Rate." }, "purchase_tax_rate_id": { "type": "string", "description": "The ID of the Purchase Tax Rate." }, "source_guid": { "type": "string", "description": "Used when importing services from external sources" }, "purchase_description": { "type": "string", "description": "The service purchase description" }, "usual_supplier_id": { "type": "string", "description": "The ID of the Usual Supplier." }, "active": { "type": "boolean", "description": "Indicates whether the service is active" }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the service" }, "oss_service": { "type": "boolean", "description": "Indicates whether the service is One Stop Shop" }, "sales_rates": { "type": "array", "items": { "type": "object", "properties": { "rate_name": { "type": "string", "description": "The name of the service rate" }, "rate": { "type": "number", "format": "double", "description": "The rate amount" }, "rate_includes_tax": { "type": "boolean", "description": "Indicates whether the rate already includes tax" }, "service_rate_type_id": { "type": "string", "description": "The ID of the Service Rate Type." } } } } } } }, "required": [ "service" ], "description": "Updates a Service" }, "ServiceRateType": { "type": "object", "properties": { "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 service rate type" }, "active": { "type": "boolean", "description": "Indicates whether the rate type is displayed in the application" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "x-sage-menusection": "Products & Services" }, "postServiceRateTypes": { "type": "object", "properties": { "service_rate_type": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the service rate type" }, "active": { "type": "boolean", "description": "Indicates whether the rate type is displayed in the application" } }, "required": [ "name", "active" ] } }, "required": [ "service_rate_type" ], "description": "Creates a Service Rate Type" }, "putServiceRateTypes": { "type": "object", "properties": { "service_rate_type": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the service rate type" }, "active": { "type": "boolean", "description": "Indicates whether the rate type is displayed in the application" } } } }, "required": [ "service_rate_type" ], "description": "Updates a Service Rate Type" }, "StockItem": { "type": "object", "properties": { "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" }, "deletable": { "type": "boolean", "description": "Indicates whether the stock item can be deleted" }, "deactivatable": { "type": "boolean", "description": "Indicates whether the stock item can be deactivated" }, "used_on_recurring_invoice": { "type": "boolean", "description": "Indicates whether the stock item has been used on a recurring invoice" }, "item_code": { "type": "string", "maxLength": 30, "description": "The item code for the stock item" }, "description": { "type": "string", "maxLength": 255, "description": "The stock item description" }, "notes": { "type": "string", "maxLength": 500, "description": "The notes for the stock item" }, "sales_ledger_account": { "$ref": "#/components/schemas/Base" }, "sales_tax_rate": { "$ref": "#/components/schemas/Base" }, "purchase_ledger_account": { "$ref": "#/components/schemas/Base" }, "usual_supplier": { "$ref": "#/components/schemas/Contact" }, "purchase_tax_rate": { "$ref": "#/components/schemas/Base" }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the stock item" }, "sales_prices": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPrice" }, "description": "The sales prices for the stock item" }, "source_guid": { "type": "string", "maxLength": 255, "description": "Used when importing stock items from external sources" }, "purchase_description": { "type": "string", "maxLength": 250, "description": "The stock item purchase description" }, "reorder_level": { "type": "number", "format": "double", "description": "The reorder level for the stock item" }, "reorder_quantity": { "type": "number", "format": "double", "description": "The reorder quantity for the stock item" }, "location": { "type": "string", "description": "The location for the stock item" }, "barcode": { "type": "string", "description": "The barcode for the stock item" }, "supplier_part_number": { "type": "string", "description": "The supplier part number for stock item" }, "weight": { "type": "number", "format": "double", "description": "The weight of stock item" }, "measurement_unit": { "type": "string", "description": "The unit of measure of weight for stock item" }, "weight_converted": { "type": "number", "format": "double", "description": "The weight of stock item converted to the lowest unit of measurement" }, "active": { "type": "boolean", "description": "Indicates whether the stock item is active" }, "quantity_in_stock": { "type": "number", "format": "double", "description": "The current quantity of the stock item held by the business" }, "last_cost_price": { "type": "number", "format": "double", "description": "The most recent 'purchase invoice' or 'adjustment in' price" }, "last_cost_price_stock_value": { "type": "number", "format": "double", "description": "The value of the current stock in terms of the last cost price" }, "average_cost_price": { "type": "number", "format": "double", "description": "The average price across all purchases of this stock item" }, "average_cost_price_stock_value": { "type": "number", "format": "double", "description": "The value of the current stock in terms of the average cost price" }, "cost_price_last_updated": { "type": "string", "format": "date", "description": "The date on which the last cost price was last updated" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Restricted Access, Full Access", "x-sage-menusection": "Products & Services" }, "postStockItems": { "type": "object", "properties": { "stock_item": { "type": "object", "properties": { "item_code": { "type": "string", "description": "The item code for the stock item" }, "description": { "type": "string", "description": "The stock item description" }, "sales_ledger_account_id": { "type": "string", "description": "The sales ledger account for the stock item" }, "purchase_ledger_account_id": { "type": "string", "description": "The purchase ledger account for the stock item" }, "notes": { "type": "string", "description": "The notes for the stock item" }, "sales_tax_rate_id": { "type": "string", "description": "The ID of the Sales Tax Rate." }, "usual_supplier_id": { "type": "string", "description": "The ID of the Usual Supplier." }, "purchase_tax_rate_id": { "type": "string", "description": "The ID of the Purchase Tax Rate." }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the stock item" }, "source_guid": { "type": "string", "description": "Used when importing stock items from external sources" }, "purchase_description": { "type": "string", "description": "The stock item purchase description" }, "reorder_level": { "type": "number", "format": "double", "description": "The reorder level for the stock item" }, "reorder_quantity": { "type": "number", "format": "double", "description": "The reorder quantity for the stock item" }, "location": { "type": "string", "description": "The location for the stock item" }, "barcode": { "type": "string", "description": "The barcode for the stock item" }, "supplier_part_number": { "type": "string", "description": "The supplier part number for stock item" }, "weight": { "type": "number", "format": "double", "description": "The weight of stock item" }, "measurement_unit": { "type": "string", "description": "The unit of measure of weight for stock item" }, "weight_converted": { "type": "number", "format": "double", "description": "The weight of stock item converted to the lowest unit of measurement" }, "active": { "type": "boolean", "description": "Indicates whether the stock item is active" }, "quantity_in_stock": { "type": "number", "format": "double", "description": "The current quantity of the stock item held by the business" }, "last_cost_price": { "type": "number", "format": "double", "description": "The most recent 'purchase invoice' or 'adjustment in' price" }, "last_cost_price_stock_value": { "type": "number", "format": "double", "description": "The value of the current stock in terms of the last cost price" }, "average_cost_price": { "type": "number", "format": "double", "description": "The average price across all purchases of this stock item" }, "average_cost_price_stock_value": { "type": "number", "format": "double", "description": "The value of the current stock in terms of the average cost price" }, "cost_price_last_updated": { "type": "string", "format": "date", "description": "The date on which the last cost price was last updated" }, "sales_prices": { "type": "array", "items": { "type": "object", "properties": { "price_name": { "type": "string", "description": "The name of the product sales price" }, "price": { "type": "number", "format": "double", "description": "The sales price amount" }, "price_includes_tax": { "type": "boolean", "description": "Indicates whether the sales price already includes tax" }, "product_sales_price_type_id": { "type": "string", "description": "The ID of the Product Sales Price Type." } } } } }, "required": [ "item_code", "description", "sales_ledger_account_id", "purchase_ledger_account_id" ] } }, "required": [ "stock_item" ], "description": "Creates a Stock Item" }, "putStockItems": { "type": "object", "properties": { "stock_item": { "type": "object", "properties": { "item_code": { "type": "string", "description": "The item code for the stock item" }, "description": { "type": "string", "description": "The stock item description" }, "sales_ledger_account_id": { "type": "string", "description": "The sales ledger account for the stock item" }, "purchase_ledger_account_id": { "type": "string", "description": "The purchase ledger account for the stock item" }, "notes": { "type": "string", "description": "The notes for the stock item" }, "sales_tax_rate_id": { "type": "string", "description": "The ID of the Sales Tax Rate." }, "usual_supplier_id": { "type": "string", "description": "The ID of the Usual Supplier." }, "purchase_tax_rate_id": { "type": "string", "description": "The ID of the Purchase Tax Rate." }, "cost_price": { "type": "number", "format": "double", "description": "The cost price of the stock item" }, "source_guid": { "type": "string", "description": "Used when importing stock items from external sources" }, "purchase_description": { "type": "string", "description": "The stock item purchase description" }, "reorder_level": { "type": "number", "format": "double", "description": "The reorder level for the stock item" }, "reorder_quantity": { "type": "number", "format": "double", "description": "The reorder quantity for the stock item" }, "location": { "type": "string", "description": "The location for the stock item" }, "barcode": { "type": "string", "description": "The barcode for the stock item" }, "supplier_part_number": { "type": "string", "description": "The supplier part number for stock item" }, "weight": { "type": "number", "format": "double", "description": "The weight of stock item" }, "measurement_unit": { "type": "string", "description": "The unit of measure of weight for stock item" }, "weight_converted": { "type": "number", "format": "double", "description": "The weight of stock item converted to the lowest unit of measurement" }, "active": { "type": "boolean", "description": "Indicates whether the stock item is active" }, "quantity_in_stock": { "type": "number", "format": "double", "description": "The current quantity of the stock item held by the business" }, "last_cost_price": { "type": "number", "format": "double", "description": "The most recent 'purchase invoice' or 'adjustment in' price" }, "last_cost_price_stock_value": { "type": "number", "format": "double", "description": "The value of the current stock in terms of the last cost price" }, "average_cost_price": { "type": "number", "format": "double", "description": "The average price across all purchases of this stock item" }, "average_cost_price_stock_value": { "type": "number", "format": "double", "description": "The value of the current stock in terms of the average cost price" }, "cost_price_last_updated": { "type": "string", "format": "date", "description": "The date on which the last cost price was last updated" }, "sales_prices": { "type": "array", "items": { "type": "object", "properties": { "price_name": { "type": "string", "description": "The name of the product sales price" }, "price": { "type": "number", "format": "double", "description": "The sales price amount" }, "price_includes_tax": { "type": "boolean", "description": "Indicates whether the sales price already includes tax" }, "product_sales_price_type_id": { "type": "string", "description": "The ID of the Product Sales Price Type." } } } } } } }, "required": [ "stock_item" ], "description": "Updates a Stock Item" }, "StockMovement": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "Display text for the stock movement" }, "$path": { "type": "string", "description": "The API path for the resource" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "Links 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" }, "movement_number": { "type": "string", "maxLength": 4, "description": "The movement number of the stock movement" }, "date": { "type": "string", "format": "date", "description": "The date the stock movement occurred" }, "cost_price": { "type": "number", "format": "double", "description": "The cost per unit of stock purchased" }, "quantity": { "type": "number", "format": "double", "description": "The quantity of the goods adjusted" }, "details": { "type": "string", "maxLength": 50, "description": "The transaction details of the stock movement" }, "reference": { "type": "string", "maxLength": 31, "description": "The reference of the stock movement" }, "stock_item": { "$ref": "#/components/schemas/StockItem" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* Area: `Products & Services`: Full Access", "x-sage-menusection": "Products & Services" }, "postStockMovements": { "type": "object", "properties": { "stock_movement": { "type": "object", "properties": { "stock_item_id": { "type": "string", "description": "The stock item of the stock movement" }, "date": { "type": "string", "format": "date", "description": "The date the stock movement occurred" }, "quantity": { "type": "number", "format": "double", "description": "The quantity of the goods adjusted" }, "cost_price": { "type": "number", "format": "double", "description": "The cost per unit of stock purchased" }, "details": { "type": "string", "description": "The transaction details of the stock movement" }, "movement_number": { "type": "string", "description": "The movement number of the stock movement" }, "reference": { "type": "string", "description": "The reference of the stock movement" } }, "required": [ "stock_item_id", "date", "quantity", "cost_price", "details" ] } }, "required": [ "stock_movement" ], "description": "Creates a Stock Movement" }, "putStockMovements": { "type": "object", "properties": { "stock_movement": { "type": "object", "properties": { "stock_item_id": { "type": "string", "description": "The stock item of the stock movement" }, "date": { "type": "string", "format": "date", "description": "The date the stock movement occurred" }, "quantity": { "type": "number", "format": "double", "description": "The quantity of the goods adjusted" }, "cost_price": { "type": "number", "format": "double", "description": "The cost per unit of stock purchased" }, "details": { "type": "string", "description": "The transaction details of the stock movement" }, "movement_number": { "type": "string", "description": "The movement number of the stock movement" }, "reference": { "type": "string", "description": "The reference of the stock movement" } } } }, "required": [ "stock_movement" ], "description": "Updates a Stock Movement" }, "postAnalysisTypeCategories": { "type": "object", "properties": { "analysis_type_category": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the analysis type category" }, "name": { "type": "string", "description": "The name of the analysis type category" }, "combined_id": { "type": "string", "description": "The combined_id of the analysis type category" }, "analysis_type_id": { "type": "string", "description": "The ID of the Analysis Type." } } } }, "required": [ "analysis_type_category" ], "description": "Creates a Analysis Type Category" }, "putAnalysisTypeCategories": { "type": "object", "properties": { "analysis_type_category": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the analysis type category" }, "name": { "type": "string", "description": "The name of the analysis type category" }, "combined_id": { "type": "string", "description": "The combined_id of the analysis type category" }, "analysis_type_id": { "type": "string", "description": "The ID of the Analysis Type." } } } }, "required": [ "analysis_type_category" ], "description": "Updates a Analysis Type Category" }, "putAnalysisTypes": { "type": "object", "properties": { "analysis_type": { "type": "object", "properties": { "active_areas": { "type": "array", "description": "The areas for which the analysis type is available", "items": { "type": "string" } }, "analysis_type_level": { "type": "array", "description": "The analysis type level", "items": { "type": "string" } }, "name": { "type": "string", "description": "The name of the analysis type" }, "analysis_type_categories": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the analysis type category" }, "name": { "type": "string", "description": "The name of the analysis type category" }, "combined_id": { "type": "string", "description": "The combined_id of the analysis type category" }, "analysis_type_id": { "type": "string", "description": "The ID of the Analysis Type." } } } } } } }, "required": [ "analysis_type" ], "description": "Updates a Analysis Type" }, "BusinessActivityType": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 15, "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": "BusinessActivityType model" }, "BusinessSettings": { "type": "object", "properties": { "$path": { "type": "string", "description": "The path for the resource" }, "siret": { "type": "string", "description": "SIRET Number (France only)" }, "management_centre_member": { "type": "boolean", "description": "Member of Approved Management Centres (France only)" }, "rcs_number": { "type": "string", "description": "RCS Number (France only)" }, "share_capital": { "type": "number", "format": "double", "description": "Share Capital (France only)" }, "business_activity_type": { "$ref": "#/components/schemas/BusinessActivityType" }, "legal_form_type": { "$ref": "#/components/schemas/LegalFormType" }, "auxiliary_accounts_visible": { "type": "boolean", "description": "Auxiliary Accounts Visible (France & Spain only)" }, "default_ledger_accounts": { "$ref": "#/components/schemas/DefaultLedgerAccounts" }, "business_type": { "$ref": "#/components/schemas/BusinessType" }, "country_of_registration": { "$ref": "#/components/schemas/Base" }, "business_created_at": { "type": "string", "format": "date-time", "description": "The timestamp on which the business was created. This can be the timestamp of the initial creation or the latest business reset." }, "updated_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was last updated" }, "wizard_complete": { "type": "boolean", "description": "Quick Start Wizard completion" } }, "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 `Settings`: Full Access", "x-sage-menusection": "Settings" }, "LegalFormType": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 15, "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": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท", "x-sage-menusection": "Settings" }, "DefaultLedgerAccounts": { "type": "object", "properties": { "bank_charges_ledger_account": { "$ref": "#/components/schemas/Base" }, "bank_interest_received_ledger_account": { "$ref": "#/components/schemas/Base" }, "bank_interest_charges_paid_ledger_account": { "$ref": "#/components/schemas/Base" }, "exchange_rate_gains_ledger_account": { "$ref": "#/components/schemas/Base" }, "exchange_rate_losses_ledger_account": { "$ref": "#/components/schemas/Base" }, "sales_ledger_account": { "$ref": "#/components/schemas/Base" }, "sales_discount_ledger_account": { "$ref": "#/components/schemas/Base" }, "purchase_ledger_account": { "$ref": "#/components/schemas/Base" }, "purchase_discount_ledger_account": { "$ref": "#/components/schemas/Base" }, "product_sales_ledger_account": { "$ref": "#/components/schemas/Base" }, "product_purchase_ledger_account": { "$ref": "#/components/schemas/Base" }, "service_sales_ledger_account": { "$ref": "#/components/schemas/Base" }, "service_purchase_ledger_account": { "$ref": "#/components/schemas/Base" }, "stock_purchase_ledger_account": { "$ref": "#/components/schemas/Base" }, "other_receipt_ledger_account": { "$ref": "#/components/schemas/Base" }, "other_payment_ledger_account": { "$ref": "#/components/schemas/Base" }, "customer_receipt_discount_ledger_account": { "$ref": "#/components/schemas/Base" }, "vendor_payment_discount_ledger_account": { "$ref": "#/components/schemas/Base" }, "carriage_ledger_account": { "$ref": "#/components/schemas/Base" } } }, "BusinessType": { "type": "object", "properties": { "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" }, "name": { "type": "string", "description": "The name of the business type" }, "description": { "type": "string", "description": "The description of the business type" } }, "description": "BusinessType model" }, "putBusinessSettings": { "type": "object", "properties": { "business_settings": { "type": "object", "properties": { "siret": { "type": "string", "description": "SIRET Number (France only)" }, "management_centre_member": { "type": "boolean", "description": "Member of Approved Management Centres (France only)" }, "rcs_number": { "type": "string", "description": "RCS Number (France only)" }, "share_capital": { "type": "number", "format": "double", "description": "Share Capital (France only)" }, "business_activity_type_id": { "type": "string", "description": "The ID of the Business Activity Type." }, "legal_form_type_id": { "type": "string", "description": "The ID of the Legal Form Type." }, "auxiliary_accounts_visible": { "type": "boolean", "description": "Auxiliary Accounts Visible (France & Spain only)" }, "business_type_id": { "type": "string", "description": "The ID of the Business Type." }, "country_of_registration_id": { "type": "string", "description": "The ID of the Country Of Registration." }, "wizard_complete": { "type": "boolean", "description": "Quick Start Wizard completion" }, "default_ledger_accounts": { "type": "object", "properties": { "bank_charges_ledger_account_id": { "type": "string", "description": "The ID of the Bank Charges Ledger Account." }, "bank_interest_received_ledger_account_id": { "type": "string", "description": "The ID of the Bank Interest Received Ledger Account." }, "bank_interest_charges_paid_ledger_account_id": { "type": "string", "description": "The ID of the Bank Interest Charges Paid Ledger Account." }, "exchange_rate_gains_ledger_account_id": { "type": "string", "description": "The ID of the Exchange Rate Gains Ledger Account." }, "exchange_rate_losses_ledger_account_id": { "type": "string", "description": "The ID of the Exchange Rate Losses Ledger Account." }, "sales_ledger_account_id": { "type": "string", "description": "The ID of the Sales Ledger Account." }, "sales_discount_ledger_account_id": { "type": "string", "description": "The ID of the Sales Discount Ledger Account." }, "purchase_ledger_account_id": { "type": "string", "description": "The ID of the Purchase Ledger Account." }, "purchase_discount_ledger_account_id": { "type": "string", "description": "The ID of the Purchase Discount Ledger Account." }, "product_sales_ledger_account_id": { "type": "string", "description": "The ID of the Product Sales Ledger Account." }, "product_purchase_ledger_account_id": { "type": "string", "description": "The ID of the Product Purchase Ledger Account." }, "service_sales_ledger_account_id": { "type": "string", "description": "The ID of the Service Sales Ledger Account." }, "service_purchase_ledger_account_id": { "type": "string", "description": "The ID of the Service Purchase Ledger Account." }, "stock_purchase_ledger_account_id": { "type": "string", "description": "The ID of the Stock Purchase Ledger Account." }, "other_receipt_ledger_account_id": { "type": "string", "description": "The ID of the Other Receipt Ledger Account." }, "other_payment_ledger_account_id": { "type": "string", "description": "The ID of the Other Payment Ledger Account." }, "customer_receipt_discount_ledger_account_id": { "type": "string", "description": "The ID of the Customer Receipt Discount Ledger Account." }, "vendor_payment_discount_ledger_account_id": { "type": "string", "description": "The ID of the Vendor Payment Discount Ledger Account." }, "carriage_ledger_account_id": { "type": "string", "description": "The ID of the Carriage Ledger Account." } } } } } }, "required": [ "business_settings" ], "description": "Updates a Business Settings" }, "CisSettings": { "type": "object", "properties": { "$path": { "type": "string", "description": "The path for the resource" }, "unique_tax_reference": { "type": "string", "maxLength": 10, "description": "Unique Tax Reference, format should match ########## (10 digits) e.g. 1234567890" }, "contractor": { "type": "boolean", "description": "Contractor status" }, "subcontractor": { "type": "boolean", "description": "Subcontractor status" }, "accounts_office_reference": { "type": "string", "maxLength": 13, "description": "Accounts Office Reference, format should match ###PX???????? e.g. 123PA1234567A or 123PA12345678" }, "paye_reference": { "type": "string", "maxLength": 14, "description": "PAYE Reference, format should match ###/X?##### e.g. 123/A45678 or 123/AB45678" }, "tax_rate": { "$ref": "#/components/schemas/Base" } }, "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "x-sage-menusection": "CIS Settings" }, "putCisSettings": { "type": "object", "properties": { "cis_settings": { "type": "object", "properties": { "unique_tax_reference": { "type": "string", "description": "Unique Tax Reference, format should match ########## (10 digits) e.g. 1234567890" }, "contractor": { "type": "boolean", "description": "Contractor status" }, "subcontractor": { "type": "boolean", "description": "Subcontractor status" }, "accounts_office_reference": { "type": "string", "description": "Accounts Office Reference, format should match ###PX???????? e.g. 123PA1234567A or 123PA12345678" }, "paye_reference": { "type": "string", "description": "PAYE Reference, format should match ###/X?##### e.g. 123/A45678 or 123/AB45678" }, "tax_rate_id": { "type": "string", "description": "The ID of the Tax Rate." } } } }, "required": [ "cis_settings" ], "description": "Updates a Cis Settings" }, "FinancialSettings": { "type": "object", "properties": { "$path": { "type": "string", "description": "The api path for this item" }, "year_end_date": { "type": "string", "format": "date", "description": "The financial year end date of the business" }, "year_end_lockdown_date": { "type": "string", "format": "date", "description": "The year end lockdown date of the business" }, "accounting_type": { "type": "string", "maxLength": 255, "description": "Indicates the accounting type of a business, it can be accrual or cash based" }, "accounts_start_date": { "type": "string", "format": "date", "description": "The accounts start date of the business" }, "base_currency": { "$ref": "#/components/schemas/Base" }, "multi_currency_enabled": { "type": "boolean", "description": "Indicates whether multi-currency is enabled for the business" }, "use_live_exchange_rates": { "type": "boolean", "description": "Indicates whether to use live or business defined exchange rates" }, "mtd_activation_status": { "type": "string", "description": "Indicates the UK Making Tax Digital for VAT activation status" }, "mtd_connected": { "type": "boolean", "description": "Indicates whether UK Making Tax Digital for VAT is currently connected" }, "mtd_authenticated_date": { "type": "string", "format": "date", "description": "Indicates when a UK business enabled UK Making Tax Digital for VAT, nil if not enabled or non-uk" }, "tax_scheme": { "$ref": "#/components/schemas/TaxScheme" }, "tax_return_frequency": { "$ref": "#/components/schemas/Base" }, "tax_number": { "type": "string", "maxLength": 255, "description": "The tax number" }, "general_tax_number": { "type": "string", "description": "The number for various tax report submissions" }, "tax_office": { "$ref": "#/components/schemas/Base" }, "default_irpf_rate": { "type": "number", "format": "double", "description": "The default IRPF rate" }, "flat_rate_tax_percentage": { "type": "number", "format": "double", "description": "The tax percentage that applies to flat rate tax schemes." }, "recoverable_percentage": { "type": "number", "format": "double", "description": "The partial recoverable tax rate (Canada only)" }, "sales_tax_calculation": { "type": "string", "description": "The method of collection for tax on sales. Allowed values - \"invoice\", \"cash\"." }, "purchase_tax_calculation": { "type": "string", "description": "The method of collection for tax on purchases. Allowed values - \"invoice\", \"cash\"." }, "updated_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was last updated" }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether to use postponed accounting or not" }, "destination_vat": { "type": "boolean", "description": "Indicates whether to use destination vat or not" } }, "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "x-sage-menusection": "Settings" }, "TaxScheme": { "type": "object", "properties": { "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": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Standard: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ\n* Accounting Start: ๐Ÿ‡ซ๐Ÿ‡ท, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช, ๐Ÿ‡ช๐Ÿ‡ธ", "x-sage-menusection": "Settings" }, "putFinancialSettings": { "type": "object", "properties": { "financial_settings": { "type": "object", "properties": { "year_end_date": { "type": "string", "format": "date", "description": "The financial year end date of the business" }, "year_end_lockdown_date": { "type": "string", "format": "date", "description": "The year end lockdown date of the business" }, "accounting_type": { "type": "string", "description": "Indicates the accounting type of a business, it can be accrual or cash based" }, "accounts_start_date": { "type": "string", "format": "date", "description": "The accounts start date of the business" }, "base_currency_id": { "type": "string", "description": "The ID of the Base Currency." }, "multi_currency_enabled": { "type": "boolean", "description": "Indicates whether multi-currency is enabled for the business" }, "use_live_exchange_rates": { "type": "boolean", "description": "Indicates whether to use live or business defined exchange rates" }, "mtd_activation_status": { "type": "string", "description": "Indicates the UK Making Tax Digital for VAT activation status" }, "mtd_connected": { "type": "boolean", "description": "Indicates whether UK Making Tax Digital for VAT is currently connected" }, "mtd_authenticated_date": { "type": "string", "format": "date", "description": "Indicates when a UK business enabled UK Making Tax Digital for VAT, nil if not enabled or non-uk" }, "tax_scheme_id": { "type": "string", "description": "The ID of the Tax Scheme." }, "tax_return_frequency_id": { "type": "string", "description": "The ID of the Tax Return Frequency." }, "tax_number": { "type": "string", "description": "The tax number" }, "general_tax_number": { "type": "string", "description": "The number for various tax report submissions" }, "tax_office_id": { "type": "string", "description": "The ID of the Tax Office." }, "default_irpf_rate": { "type": "number", "format": "double", "description": "The default IRPF rate" }, "flat_rate_tax_percentage": { "type": "number", "format": "double", "description": "The tax percentage that applies to flat rate tax schemes." }, "recoverable_percentage": { "type": "number", "format": "double", "description": "The partial recoverable tax rate (Canada only)" }, "sales_tax_calculation": { "type": "string", "description": "The method of collection for tax on sales. Allowed values - \"invoice\", \"cash\"." }, "purchase_tax_calculation": { "type": "string", "description": "The method of collection for tax on purchases. Allowed values - \"invoice\", \"cash\"." }, "postponed_accounting": { "type": "boolean", "description": "Indicates whether to use postponed accounting or not" }, "destination_vat": { "type": "boolean", "description": "Indicates whether to use destination vat or not" } } } }, "required": [ "financial_settings" ], "description": "Updates a Financial Settings" }, "InvoiceSettings": { "type": "object", "properties": { "$path": { "type": "string", "description": "The path for the resource" }, "next_invoice_number": { "type": "integer", "format": "int32", "description": "The next invoice number" }, "next_credit_note_number": { "type": "integer", "format": "int32", "description": "The next credit note number" }, "separate_invoice_credit_note_numbering": { "type": "boolean", "description": "Indicates whether to use separate or combined number sequences for invoices and credit notes" }, "sales_invoice_number_prefix": { "type": "string", "maxLength": 6, "description": "The prefix to use for sales invoices" }, "sales_credit_note_number_prefix": { "type": "string", "maxLength": 6, "description": "The prefix to use for sales credit notes" }, "invoice_terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "The default terms and conditions to include on invoices" }, "default_note_on_invoice": { "type": "string", "maxLength": 2000, "description": "The default notes to include on invoices" }, "default_note_on_credit_note": { "type": "string", "maxLength": 2000, "description": "The default notes to include on credit notes" }, "default_note_on_estimate": { "type": "string", "maxLength": 2000, "description": "The default notes to include on estimates" }, "default_note_on_quote": { "type": "string", "maxLength": 2000, "description": "The default notes to include on quotes" }, "next_quote_number": { "type": "integer", "format": "int32", "description": "The next quote number" }, "quote_number_prefix": { "type": "string", "maxLength": 6, "description": "The prefix to use for sales quotes" }, "estimate_number_prefix": { "type": "string", "maxLength": 6, "description": "The prefix to use for sales estimates" }, "quote_default_days_to_expiry": { "type": "integer", "format": "int32", "description": "The default number of days before quotes expire" }, "estimate_default_days_to_expiry": { "type": "integer", "format": "int32", "description": "The default number of days before estimates expire" }, "quote_terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "The default terms and conditions to include on quotes" }, "estimate_terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "The default terms and conditions to include on estimates" }, "delivery_note_terms_and_conditions": { "type": "string", "maxLength": 2000, "description": "The default terms and conditions to include on delivery notes" }, "delivery_note_show_signature": { "type": "boolean", "description": "Indicates whether to include the signature lines on delivery notes" }, "delivery_note_show_picked": { "type": "boolean", "description": "Indicates whether to include the picked column on delivery notes" }, "delivery_note_show_notes": { "type": "boolean", "description": "Indicates whether to include the document notes on delivery notes" }, "delivery_note_show_contact_details": { "type": "boolean", "description": "Indicates whether to include contact details on delivery notes" }, "quick_entry_prefix": { "type": "string", "maxLength": 6, "description": "The prefix to use for quick entries" }, "late_payment_percentage": { "type": "number", "format": "double", "description": "The percentage charge applied to late payment of invoices (France only)" }, "prompt_payment_percentage": { "type": "number", "format": "double", "description": "The percentage applied to late payment of invoices (France only)" }, "show_auto_entrepreneur": { "type": "boolean", "description": "Indicates whether to include auto entrepreneur details on invoices (France only)" }, "show_insurance": { "type": "boolean", "description": "Indicates whether to include insurance details on invoices (France only)" }, "insurer": { "$ref": "#/components/schemas/Contact" }, "insurance_area": { "type": "string", "description": "The insurance area to be displayed on invoices (France only)" }, "insurance_type": { "type": "string", "description": "The insurance type to be displayed on invoices (France only)" }, "insurance_text": { "type": "string", "description": "The insurance mention to be displayed on invoices (France only)" }, "payment_bank_account": { "$ref": "#/components/schemas/Base" }, "sales_corrective_invoice_number_prefix": { "type": "string", "maxLength": 255, "description": "The sales corrective invoice number prefix (Spain only)" }, "next_sales_corrective_invoice_number": { "type": "integer", "format": "int32", "description": "The next sales corrective invoice number" }, "document_headings": { "$ref": "#/components/schemas/InvoiceSettingsDocumentHeadings" }, "line_item_titles": { "$ref": "#/components/schemas/InvoiceSettingsLineItemTitles" }, "footer_details": { "$ref": "#/components/schemas/FooterDetails" }, "print_contact_details": { "$ref": "#/components/schemas/PrintContactDetails" }, "print_statements": { "$ref": "#/components/schemas/PrintStatements" }, "customer_credit_days": { "type": "integer", "format": "int32", "description": "The default delay within which the business' customer has to pay an invoice\nPrefer the (customer) contact's attribute 'credit_days' over this setting\nto calculate an invoice's date of payment; only if null, use this as default.\n" }, "vendor_credit_days": { "type": "integer", "format": "int32", "description": "The default delay within which the business has to pay any vendor's invoice\nPrefer the specific (vendor) contact's attribute 'credit_days' over this setting;\nonly if null, use this as default.\n" }, "customer_credit_terms": { "type": "string", "enum": [ "month_end_invoice", "date_from_invoice", "immediate_invoice" ], "description": "The default credit terms options determine how invoice due dates are calculated.\nOptions include: end of next month, a delay of customer credit_days and immediately.\nOnly: month_end_invoice, date_from_invoice, immediate_invoice are valid values.\nPrefer the (customer) contact's credit terms over this setting\nto calculate an invoice's date of payment; only if null, use this as default.\n" }, "vendor_credit_terms": { "type": "string", "enum": [ "month_end_payment", "date_from_payment", "immediate_payment" ], "description": "The default credit terms options determine how invoice due dates are calculated.\nOptions include: end of next month, a delay of supplier credit_days and immediately.\nOnly: month_end_payment, date_from_payment, immediate_payment are valid values.\nPrefer the (vendor) contact's credit terms over this setting\nto calculate an invoice's date of payment; only if null, use this as default.\n" }, "updated_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was last updated" } }, "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "x-sage-menusection": "Settings" }, "InvoiceSettingsDocumentHeadings": { "type": "object", "properties": { "sales_invoice": { "type": "string", "description": "The customisable sales invoice document header" }, "sales_credit_note": { "type": "string", "description": "The customisable sales credit note document header" }, "sales_corrective_invoice": { "type": "string", "description": "The customisable sales corrective invoice document header" }, "sales_quote": { "type": "string", "description": "The customisable sales quote document header" }, "sales_estimate": { "type": "string", "description": "The customisable sales estimate document header" }, "pro_forma": { "type": "string", "description": "The customisable pro forma document header" }, "remittance_advice": { "type": "string", "description": "The customisable remittance advice document header" }, "statement": { "type": "string", "description": "The customisable statement document header" }, "delivery_note": { "type": "string", "description": "The customisable delivery note document header" } } }, "InvoiceSettingsLineItemTitles": { "type": "object", "properties": { "description": { "type": "string", "description": "The user defined description column title" }, "unit_price": { "type": "string", "description": "The user defined unit price column title" }, "quantity": { "type": "string", "description": "The user defined quantity column title" }, "discount": { "type": "string", "description": "The user defined discount column title" } } }, "FooterDetails": { "type": "object", "properties": { "column_1": { "type": "string", "description": "The pdf footer details for column 1" }, "column_2": { "type": "string", "description": "The pdf footer details for column 2" }, "column_3": { "type": "string", "description": "The pdf footer details for column 3" } } }, "PrintContactDetails": { "type": "object", "properties": { "business_name": { "type": "boolean", "description": "Indicates whether business name is printed on the invoice" }, "website": { "type": "boolean", "description": "Indicates whether website is printed on the invoice" }, "telephone": { "type": "boolean", "description": "Indicates whether telephone is printed on the invoice" }, "mobile": { "type": "boolean", "description": "Indicates whether mobile is printed on the invoice" }, "email_address": { "type": "boolean", "description": "Indicates whether email address is printed on the invoice" }, "due_date": { "type": "boolean", "description": "Indicates whether due date is printed on the invoice" }, "default_delivery_address": { "type": "string", "description": "Indicates which contact address is used for the delivery address of the invoice. Valid options are: INVOICE_ADDRESS, CONTACT_DELIVERY_ADDRESS, NONE." } } }, "PrintStatements": { "type": "object", "properties": { "days_overdue": { "type": "boolean", "description": "Indicates whether days of overdue are printed in the contact's statement" }, "table_of_balances": { "type": "boolean", "description": "Indicates whether table of balances is printed in the contact's statement" } } }, "putInvoiceSettings": { "type": "object", "properties": { "invoice_settings": { "type": "object", "properties": { "next_invoice_number": { "type": "integer", "format": "int32", "description": "The next invoice number", "minimum": 1, "maximum": 999999999 }, "next_credit_note_number": { "type": "integer", "format": "int32", "description": "The next credit note number", "minimum": 1, "maximum": 999999999 }, "separate_invoice_credit_note_numbering": { "type": "boolean", "description": "Indicates whether to use separate or combined number sequences for invoices and credit notes" }, "sales_invoice_number_prefix": { "type": "string", "description": "The prefix to use for sales invoices" }, "sales_credit_note_number_prefix": { "type": "string", "description": "The prefix to use for sales credit notes" }, "invoice_terms_and_conditions": { "type": "string", "description": "The default terms and conditions to include on invoices" }, "default_note_on_invoice": { "type": "string", "description": "The default notes to include on invoices" }, "default_note_on_credit_note": { "type": "string", "description": "The default notes to include on credit notes" }, "default_note_on_estimate": { "type": "string", "description": "The default notes to include on estimates" }, "default_note_on_quote": { "type": "string", "description": "The default notes to include on quotes" }, "next_quote_number": { "type": "integer", "format": "int32", "description": "The next quote number", "minimum": 1, "maximum": 999999999 }, "quote_number_prefix": { "type": "string", "description": "The prefix to use for sales quotes" }, "estimate_number_prefix": { "type": "string", "description": "The prefix to use for sales estimates" }, "quote_default_days_to_expiry": { "type": "integer", "format": "int32", "description": "The default number of days before quotes expire", "minimum": 0, "maximum": 365 }, "estimate_default_days_to_expiry": { "type": "integer", "format": "int32", "description": "The default number of days before estimates expire", "minimum": 0, "maximum": 365 }, "quote_terms_and_conditions": { "type": "string", "description": "The default terms and conditions to include on quotes" }, "estimate_terms_and_conditions": { "type": "string", "description": "The default terms and conditions to include on estimates" }, "delivery_note_terms_and_conditions": { "type": "string", "description": "The default terms and conditions to include on delivery notes" }, "delivery_note_show_signature": { "type": "boolean", "description": "Indicates whether to include the signature lines on delivery notes" }, "delivery_note_show_picked": { "type": "boolean", "description": "Indicates whether to include the picked column on delivery notes" }, "delivery_note_show_notes": { "type": "boolean", "description": "Indicates whether to include the document notes on delivery notes" }, "delivery_note_show_contact_details": { "type": "boolean", "description": "Indicates whether to include contact details on delivery notes" }, "quick_entry_prefix": { "type": "string", "description": "The prefix to use for quick entries" }, "late_payment_percentage": { "type": "number", "format": "double", "description": "The percentage charge applied to late payment of invoices (France only)" }, "prompt_payment_percentage": { "type": "number", "format": "double", "description": "The percentage applied to late payment of invoices (France only)" }, "show_auto_entrepreneur": { "type": "boolean", "description": "Indicates whether to include auto entrepreneur details on invoices (France only)" }, "show_insurance": { "type": "boolean", "description": "Indicates whether to include insurance details on invoices (France only)" }, "insurer_id": { "type": "string", "description": "The ID of the Insurer. (France only)" }, "insurance_area": { "type": "string", "description": "The insurance area to be displayed on invoices (France only)" }, "insurance_type": { "type": "string", "description": "The insurance type to be displayed on invoices (France only)" }, "insurance_text": { "type": "string", "description": "The insurance mention to be displayed on invoices (France only)" }, "payment_bank_account_id": { "type": "string", "description": "The ID of the Payment Bank Account." }, "sales_corrective_invoice_number_prefix": { "type": "string", "description": "The sales corrective invoice number prefix (Spain only)" }, "next_sales_corrective_invoice_number": { "type": "integer", "format": "int32", "description": "The next sales corrective invoice number", "minimum": 1, "maximum": 2147483647 }, "customer_credit_days": { "type": "integer", "format": "int32", "description": "The default delay within which the business' customer has to pay an invoice\nPrefer the (customer) contact's attribute 'credit_days' over this setting\nto calculate an invoice's date of payment; only if null, use this as default.\n", "minimum": 0, "maximum": 365 }, "vendor_credit_days": { "type": "integer", "format": "int32", "description": "The default delay within which the business has to pay any vendor's invoice\nPrefer the specific (vendor) contact's attribute 'credit_days' over this setting;\nonly if null, use this as default.\n", "minimum": 0, "maximum": 365 }, "customer_credit_terms": { "type": "string", "description": "The default credit terms options determine how invoice due dates are calculated.\nOptions include: end of next month, a delay of customer credit_days and immediately.\nOnly: month_end_invoice, date_from_invoice, immediate_invoice are valid values.\nPrefer the (customer) contact's credit terms over this setting\nto calculate an invoice's date of payment; only if null, use this as default.\n", "enum": [ "month_end_invoice", "date_from_invoice", "immediate_invoice" ] }, "vendor_credit_terms": { "type": "string", "description": "The default credit terms options determine how invoice due dates are calculated.\nOptions include: end of next month, a delay of supplier credit_days and immediately.\nOnly: month_end_payment, date_from_payment, immediate_payment are valid values.\nPrefer the (vendor) contact's credit terms over this setting\nto calculate an invoice's date of payment; only if null, use this as default.\n", "enum": [ "month_end_payment", "date_from_payment", "immediate_payment" ] }, "document_headings": { "type": "object", "properties": { "sales_invoice": { "type": "string", "description": "The customisable sales invoice document header" }, "sales_credit_note": { "type": "string", "description": "The customisable sales credit note document header" }, "sales_corrective_invoice": { "type": "string", "description": "The customisable sales corrective invoice document header" }, "sales_quote": { "type": "string", "description": "The customisable sales quote document header" }, "sales_estimate": { "type": "string", "description": "The customisable sales estimate document header" }, "pro_forma": { "type": "string", "description": "The customisable pro forma document header" }, "remittance_advice": { "type": "string", "description": "The customisable remittance advice document header" }, "statement": { "type": "string", "description": "The customisable statement document header" }, "delivery_note": { "type": "string", "description": "The customisable delivery note document header" } } }, "line_item_titles": { "type": "object", "properties": { "description": { "type": "string", "description": "The user defined description column title" }, "unit_price": { "type": "string", "description": "The user defined unit price column title" }, "quantity": { "type": "string", "description": "The user defined quantity column title" }, "discount": { "type": "string", "description": "The user defined discount column title" } } }, "footer_details": { "type": "object", "properties": { "column_1": { "type": "string", "description": "The pdf footer details for column 1" }, "column_2": { "type": "string", "description": "The pdf footer details for column 2" }, "column_3": { "type": "string", "description": "The pdf footer details for column 3" } } }, "print_contact_details": { "type": "object", "properties": { "business_name": { "type": "boolean", "description": "Indicates whether business name is printed on the invoice" }, "website": { "type": "boolean", "description": "Indicates whether website is printed on the invoice" }, "telephone": { "type": "boolean", "description": "Indicates whether telephone is printed on the invoice" }, "mobile": { "type": "boolean", "description": "Indicates whether mobile is printed on the invoice" }, "email_address": { "type": "boolean", "description": "Indicates whether email address is printed on the invoice" }, "due_date": { "type": "boolean", "description": "Indicates whether due date is printed on the invoice" }, "default_delivery_address": { "type": "string", "description": "Indicates which contact address is used for the delivery address of the invoice. Valid options are: INVOICE_ADDRESS, CONTACT_DELIVERY_ADDRESS, NONE." } } }, "print_statements": { "type": "object", "properties": { "days_overdue": { "type": "boolean", "description": "Indicates whether days of overdue are printed in the contact's statement" }, "table_of_balances": { "type": "boolean", "description": "Indicates whether table of balances is printed in the contact's statement" } } } } } }, "required": [ "invoice_settings" ], "description": "Updates a Invoice Settings" }, "DraftTaxReturn": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "Display text for the item, includes the period the tax return covers." }, "$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" }, "tax_return_number": { "type": "string", "maxLength": 4, "description": "The tax return number." }, "period_start_date": { "type": "string", "format": "date", "description": "The tax return from date. This is the start date of the period the tax return covers." }, "period_end_date": { "type": "string", "format": "date", "description": "The tax return to date. This is the end date of the period the tax return covers." }, "total_amount": { "type": "number", "format": "double", "description": "The tax return total amount." }, "paid": { "type": "boolean", "description": "The tax return paid status." }, "status": { "$ref": "#/components/schemas/TaxReturnStatus" }, "tax_return_type": { "$ref": "#/components/schemas/TaxReturnType" }, "tax_return_id": { "type": "integer", "format": "int32", "description": "The tax return id." }, "submitted_date": { "type": "string", "format": "date", "description": "Date when the tax return was submitted" } }, "description": "DraftTaxReturn model", "x-sage-menusection": "Draft Tax Returns" }, "TaxReturnStatus": { "type": "object", "properties": { "id": { "type": "string", "description": "The tax return status id" }, "name": { "type": "string", "description": "The return status name" } } }, "TaxReturnType": { "type": "object", "properties": { "id": { "type": "string", "description": "The tax return status id" }, "name": { "type": "string", "description": "The return status name" } } }, "TaxOffice": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 17, "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" }, "office_number": { "type": "string", "maxLength": 4, "description": "The tax office number" }, "name": { "type": "string", "maxLength": 255, "description": "The tax office name" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡ฉ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฉ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡ฉ๐Ÿ‡ช", "x-sage-menusection": "Settings" }, "TaxProfile": { "type": "object", "properties": { "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" }, "tax_type": { "$ref": "#/components/schemas/Base" }, "tax_number": { "type": "string", "maxLength": 255, "description": "The tax number" }, "tax_number_suffix": { "type": "string", "maxLength": 255, "description": "The tax number suffix" }, "collect_tax": { "type": "boolean", "description": "Indicates whether tax is collected for this tax type" }, "tax_return_frequency": { "$ref": "#/components/schemas/Base" }, "address_region": { "$ref": "#/components/schemas/AddressRegion" } }, "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 mentioned role in one of the listed areas:\n* Area: `Settings`: Full Access", "x-sage-menusection": "Settings" }, "putTaxProfiles": { "type": "object", "properties": { "tax_profile": { "type": "object", "properties": { "tax_type_id": { "type": "string", "description": "The ID of the Tax Type." }, "tax_number": { "type": "string", "description": "The tax number" }, "tax_number_suffix": { "type": "string", "description": "The tax number suffix" }, "collect_tax": { "type": "boolean", "description": "Indicates whether tax is collected for this tax type" }, "tax_return_frequency_id": { "type": "string", "description": "The ID of the Tax Return Frequency." }, "address_region": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the address region" }, "code": { "type": "string", "description": "The code of the address region" } } } } } }, "required": [ "tax_profile" ], "description": "Updates a Tax Profile" }, "postTaxRates": { "type": "object", "properties": { "tax_rate": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tax rate" }, "agency": { "type": "string", "description": "The agency name (US Only)" }, "is_visible": { "type": "boolean", "description": "Indicates whether the tax rate is visible in the application" }, "component_tax_rate": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tax rate" }, "agency": { "type": "string", "description": "The agency name (US Only)" }, "percentage": { "type": "number", "format": "double", "description": "The tax rate percentage" } }, "required": [ "name" ] } } }, "required": [ "name" ] } }, "required": [ "tax_rate" ], "description": "Creates a Tax Rate (US only)" }, "putTaxRates": { "type": "object", "properties": { "tax_rate": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tax rate" }, "from_date": { "type": "string", "format": "date-time", "description": "The date from which the tax rate applies" }, "agency": { "type": "string", "description": "The agency name (US Only)" }, "percentage": { "type": "number", "format": "double", "description": "The tax rate percentage" }, "is_visible": { "type": "boolean", "description": "Indicates whether the tax rate is visible in the application" } } } }, "required": [ "tax_rate" ], "description": "Updates a Tax Rate (US only)" }, "TaxType": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 15, "description": "The tax type id" }, "displayed_as": { "type": "string", "description": "Display text for the item" }, "$path": { "type": "string", "description": "The API path for the resource" }, "federal_tax": { "type": "boolean", "description": "Indicates whether this is a federal tax type" }, "country": { "$ref": "#/components/schemas/Base" }, "address_regions": { "type": "array", "items": { "$ref": "#/components/schemas/Base" }, "description": "The address regions the tax type relates to" }, "tax_rates": { "type": "array", "items": { "$ref": "#/components/schemas/Base" }, "description": "The tax rates related to the tax type" } }, "description": "### Endpoint Availability\n\n* Accounting Plus: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Standard: ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช\n* Accounting Start: ๐Ÿ‡จ๐Ÿ‡ฆ, ๐Ÿ‡ฌ๐Ÿ‡ง, ๐Ÿ‡ฎ๐Ÿ‡ช", "x-sage-menusection": "Settings" }, "TaxReturn": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the item" }, "displayed_as": { "type": "string", "description": "Display text for the item, includes the period the tax return covers." }, "$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" }, "tax_return_number": { "type": "string", "maxLength": 4, "description": "The tax return number." }, "period_start_date": { "type": "string", "format": "date", "description": "The tax return from date. This is the start date of the period the tax return covers." }, "period_end_date": { "type": "string", "format": "date", "description": "The tax return to date. This is the end date of the period the tax return covers." }, "total_amount": { "type": "number", "format": "double", "description": "The tax return total amount." }, "paid": { "type": "boolean", "description": "The tax return paid status." }, "status": { "$ref": "#/components/schemas/TaxReturnStatus" }, "tax_return_type": { "$ref": "#/components/schemas/TaxReturnType" } }, "description": "TaxReturn model" }, "MtdObligationPeriod": { "type": "object", "properties": { "start_date": { "type": "string", "format": "date", "description": "The start date of this obligation period." }, "end_date": { "type": "string", "format": "date", "description": "The end date of this obligation period." }, "due_date": { "type": "string", "format": "date", "description": "The due date for this obligation period." }, "received_date": { "type": "string", "format": "date", "description": "The obligation received date, is returned when status is (F = Fulfilled)." }, "hmrc_status": { "type": "string", "description": "Which obligation statuses to return (O = Open, F = Fulfilled)" }, "period_key": { "type": "string", "description": "The ID code for the period that this obligation belongs to.The format is four alphanumeric characters. Occasionally the format includes the # symbol." }, "status": { "type": "string", "description": "The status of the obligation period, nil unless the period is already used in a VAT returnThe status is one of the following: Draft, Submitted, Submission Failed, Queued, Waiting" } }, "description": "MtdObligationPeriod model" }, "GBBoxData": { "type": "object", "properties": { "box_1": { "type": "number", "format": "double", "description": "The value of box 1" }, "box_2": { "type": "number", "format": "double", "description": "The value of box 2" }, "box_3": { "type": "number", "format": "double", "description": "The value of box 3" }, "box_4": { "type": "number", "format": "double", "description": "The value of box 4" }, "box_5": { "type": "number", "format": "double", "description": "The value of box 5" }, "box_6": { "type": "number", "format": "double", "description": "The value of box 6" }, "box_7": { "type": "number", "format": "double", "description": "The value of box 7" }, "box_8": { "type": "number", "format": "double", "description": "The value of box 8" }, "box_9": { "type": "number", "format": "double", "description": "The value of box 9" } } }, "IEBoxData": { "type": "object", "properties": { "box_T1": { "type": "number", "format": "double", "description": "The value of box T1" }, "box_T2": { "type": "number", "format": "double", "description": "The value of box T2" }, "box_T3": { "type": "number", "format": "double", "description": "The value of box T3" }, "box_T4": { "type": "number", "format": "double", "description": "The value of box T4" }, "box_E1": { "type": "number", "format": "double", "description": "The value of box E1" }, "box_E2": { "type": "number", "format": "double", "description": "The value of box E2" }, "box_ES1": { "type": "number", "format": "double", "description": "The value of box ES1" }, "box_ES2": { "type": "number", "format": "double", "description": "The value of box ES2" } } }, "postMigrationTaxReturns": { "type": "object", "properties": { "migration_tax_return": { "type": "object", "properties": { "from_date": { "type": "string", "format": "date", "description": "The start date of the tax return" }, "to_date": { "type": "string", "format": "date", "description": "The end date of the tax return" }, "total_amount": { "type": "number", "format": "double", "description": "The total of the tax return" }, "tax_return_frequency_id": { "type": "string", "description": "The tax return submission frequency" }, "gb": { "type": "object", "properties": { "box_1": { "type": "number", "format": "double", "description": "The value of box 1" }, "box_2": { "type": "number", "format": "double", "description": "The value of box 2" }, "box_3": { "type": "number", "format": "double", "description": "The value of box 3" }, "box_4": { "type": "number", "format": "double", "description": "The value of box 4" }, "box_5": { "type": "number", "format": "double", "description": "The value of box 5" }, "box_6": { "type": "number", "format": "double", "description": "The value of box 6" }, "box_7": { "type": "number", "format": "double", "description": "The value of box 7" }, "box_8": { "type": "number", "format": "double", "description": "The value of box 8" }, "box_9": { "type": "number", "format": "double", "description": "The value of box 9" } } }, "ie": { "type": "object", "properties": { "box_T1": { "type": "number", "format": "double", "description": "The value of box T1" }, "box_T2": { "type": "number", "format": "double", "description": "The value of box T2" }, "box_T3": { "type": "number", "format": "double", "description": "The value of box T3" }, "box_T4": { "type": "number", "format": "double", "description": "The value of box T4" }, "box_E1": { "type": "number", "format": "double", "description": "The value of box E1" }, "box_E2": { "type": "number", "format": "double", "description": "The value of box E2" }, "box_ES1": { "type": "number", "format": "double", "description": "The value of box ES1" }, "box_ES2": { "type": "number", "format": "double", "description": "The value of box ES2" } } } }, "required": [ "from_date", "to_date", "total_amount", "tax_return_frequency_id" ] } }, "required": [ "migration_tax_return" ], "description": "Creates a Migration Tax Return" }, "EmailSettings": { "type": "object", "properties": { "default_messages": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultMessages" }, "description": "The default email messages for the businesses per message type and locale." }, "pdf_attached": { "type": "boolean", "description": "Indicates whether PDFs are always attached as part of sending emails for a business" }, "send_bcc": { "type": "boolean", "description": "Indicates whether the user should always be sent a copy when sending a document via email" }, "updated_at": { "type": "string", "format": "date-time", "description": "The datetime when the item was last updated" } }, "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 `Settings`: Full Access", "x-sage-menusection": "Settings" }, "DefaultMessages": { "type": "object", "properties": { "message_type": { "type": "string", "description": "The message type defined against a given message (example of this is invoice)" }, "locale": { "type": "string", "description": "The locale for a given message" }, "message": { "type": "string", "description": "The message for a given message type and locale" } } }, "putEmailSettings": { "type": "object", "properties": { "email_settings": { "type": "object", "properties": { "pdf_attached": { "type": "boolean", "description": "Indicates whether PDFs are always attached as part of sending emails for a business" }, "send_bcc": { "type": "boolean", "description": "Indicates whether the user should always be sent a copy when sending a document via email" }, "default_messages": { "type": "array", "items": { "type": "object", "properties": { "message_type": { "type": "string", "description": "The message type defined against a given message (example of this is invoice)" }, "locale": { "type": "string", "description": "The locale for a given message" }, "message": { "type": "string", "description": "The message for a given message type and locale" } } } } } } }, "required": [ "email_settings" ], "description": "Updates a Email Settings" } } } }