### GET /discount_or_surcharge_types Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of available discount or surcharge types. This specifies whether a percentage is applied as a discount or surcharge. ```APIDOC ## GET /discount_or_surcharge_types ### Description Retrieves a list of available discount or surcharge types. This specifies whether a percentage is applied as a discount or surcharge. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/discount_or_surcharge_types ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the discount or surcharge type. - **description** (string) - A description of the type (e.g., 'Discount', 'Surcharge'). - **value** (string) - The value representing the type. #### Response Example ```json [ { "id": 0, "description": "string", "value": "string" } ] ``` #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### GET /system_settings Source: https://developer.sage.com/200/professional/2025-r2/general Retrieves the system settings, which define operational and transaction configurations for Sage 200. ```APIDOC ## GET /system_settings ### Description The System Settings are used to define operation and transaction settings. Operational settings include setting such as the next VAT return date and number of open accounting periods. Transaction settings gives options to use additional transaction analysis and whether to validate transaction dates. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/system_settings ### Parameters #### Query Parameters - **X-Site** (string) - Required - The ID of the site to access. ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the system settings. - **next_urn** (string) - The next VAT return number. - **next_invoice_number** (integer) - The next invoice number. - **next_credit_note_number** (integer) - The next credit note number. - **next_journal_entry_number** (integer) - The next journal entry number. - **first_vat_return_date_defined** (boolean) - Indicates if the first VAT return date is defined. - **first_vat_return_date** (string) - The date of the first VAT return (ISO 8601 format). - **intrastat_value_for_consolidation** (number) - The Intrastat value for consolidation. - **number_open_periods** (integer) - The number of open accounting periods. - **update_nominal_online** (boolean) - Indicates if nominal ledger updates are performed online. - **use_cost_centre_breakdown** (boolean) - Indicates if cost centre breakdown is used. - **use_intrastat_reporting** (boolean) - Indicates if Intrastat reporting is used. - **use_period_exchange_rates** (boolean) - Indicates if period exchange rates are used. - **use_segmented_address** (boolean) - Indicates if segmented addresses are used. - **use_additional_trans_analysis** (boolean) - Indicates if additional transaction analysis is used. - **transaction_analysis_heading** (string) - The heading for transaction analysis. - **accounting_period_validation_type** (string) - The type of accounting period validation. - **financial_year_end_date** (string) - The financial year end date (ISO 8601 format). - **invoice_credit_note_same_numbers** (boolean) - Indicates if invoice and credit note use the same numbering. - **reverse_charge_minimum_value** (number) - The minimum value for reverse charge. - **transaction_date_validation** (object) - Object containing transaction date validation settings. - **id** (integer) - The unique identifier for transaction date validation. - **transaction_date_validation_type** (string) - The type of transaction date validation. - **pre_days_normal** (integer) - Number of pre-days for normal validation. - **post_days_normal** (integer) - Number of post-days for normal validation. - **pre_days_acceptable** (integer) - Number of acceptable pre-days. - **post_days_acceptable** (integer) - Number of acceptable post-days. - **previous_year_classification** (string) - Classification for previous year dates. - **future_year_classification** (string) - Classification for future year dates. - **closed_period_classification** (string) - Classification for closed period dates. - **future_period_classification** (string) - Classification for future period dates. - **date_time_created** (string) - The date and time the validation was created (ISO 8601 format). - **date_time_updated** (string) - The date and time the validation was last updated (ISO 8601 format). - **date_time_created** (string) - The date and time the settings were created (ISO 8601 format). - **date_time_updated** (string) - The date and time the settings were last updated (ISO 8601 format). #### Response Example ```json [ { "id": 0, "next_urn": "string", "next_invoice_number": 0, "next_credit_note_number": 0, "next_journal_entry_number": 0, "first_vat_return_date_defined": false, "first_vat_return_date": "2019-08-24T14:15:22Z", "intrastat_value_for_consolidation": 0, "number_open_periods": 0, "update_nominal_online": false, "use_cost_centre_breakdown": false, "use_intrastat_reporting": false, "use_period_exchange_rates": false, "use_segmented_address": true, "use_additional_trans_analysis": false, "transaction_analysis_heading": "string", "accounting_period_validation_type": "string", "financial_year_end_date": "2019-08-24T14:15:22Z", "invoice_credit_note_same_numbers": true, "reverse_charge_minimum_value": 0, "transaction_date_validation": { "id": 0, "transaction_date_validation_type": "string", "pre_days_normal": 0, "post_days_normal": 0, "pre_days_acceptable": 0, "post_days_acceptable": 0, "previous_year_classification": "string", "future_year_classification": "string", "closed_period_classification": "string", "future_period_classification": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" }, "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` ``` -------------------------------- ### GET /customer_price_bands Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of all customer price bands, showing the linkage between customers and price bands. ```APIDOC ## GET /customer_price_bands ### Description Retrieves a list of all customer price bands, showing the linkage between customers and price bands. One customer can have multiple limited price bands, and one price band can be linked to many customers. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customer_price_bands ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the customer price band linkage. - **customer_id** (integer) - The ID of the customer. - **price_band_id** (integer) - The ID of the price band. - **is_to_delete** (boolean) - Flag indicating if this linkage should be deleted. - **price_band** (object) - Details of the associated price band (structure not detailed here). - **date_time_created** (string) - The date and time when the linkage was created (ISO 8601 format). - **date_time_updated** (string) - The date and time when the linkage was last updated (ISO 8601 format). #### Response Example ```json [ { "id": 0, "customer_id": 0, "price_band_id": 0, "is_to_delete": true, "price_band": { }, "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### Get Licence Information Source: https://developer.sage.com/200/professional/2025-r2/general Returns the license details for the application, indicating which modules are enabled. ```APIDOC ## GET /licence ### Description Returns the license details for the application, indicating which modules are enabled. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/licence ### Responses #### Success Response (200) The license was successfully returned. Response body will include the license details. #### Response Example (200) ```json { "is_sales_enabled": true, "is_purchase_enabled": true, "is_nominal_enabled": true, "is_fixed_assets_enabled": true, "is_cash_book_enabled": true, "is_stock_enabled": true, "is_price_book_enabled": true, "is_invoicing_enabled": true, "is_sales_orders_enabled": true, "is_purchase_orders_enabled": true, "is_bill_of_materials_enabled": true, "is_additional_excel_reports_enabled": true, "is_project_accounting_enabled": true, "is_manufacturing_enabled": true, "is_business_intelligence_enabled": true, "is_scripting_enabled": true } ``` #### Error Response (400) There was a problem with the request. Request body will include details. ``` -------------------------------- ### GET /customer_discount_groups Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of all customer discount groups. These groups allow for applying discounts to multiple customers simultaneously. ```APIDOC ## GET /customer_discount_groups ### Description Retrieves a list of all customer discount groups. These groups allow for applying discounts to multiple customers simultaneously. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customer_discount_groups ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the customer discount group. - **name** (string) - The name of the customer discount group. - **description** (string) - A description of the customer discount group. - **date_time_created** (string) - The date and time when the customer discount group was created (ISO 8601 format). - **date_time_updated** (string) - The date and time when the customer discount group was last updated (ISO 8601 format). #### Response Example ```json [ { "id": 0, "name": "string", "description": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### GET /price_book_settings Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves the Price Book settings, which are used to configure application behavior related to the Price Book module, including pricing discounts. ```APIDOC ## GET /price_book_settings ### Description Retrieves the Price Book settings, which are used to configure application behavior related to the Price Book module, including pricing discounts. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/price_book_settings ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) *The response structure for this endpoint is not detailed in the provided text. It is expected to contain configuration details for the Price Book module.* #### Response Example *No example provided in the source text.* #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### GET /order_value_discounts Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of all order value discounts. These discounts are applied based on the total value of an invoice or sales order. ```APIDOC ## GET /order_value_discounts ### Description Retrieves a list of all order value discounts. These discounts are applied based on the total value of an invoice or sales order. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/order_value_discounts ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the discount. - **name** (string) - The name of the discount. - **description** (string) - A description of the discount. - **currency_id** (integer) - The ID of the currency associated with the discount. - **date_time_created** (string) - The date and time when the discount was created (ISO 8601 format). - **date_time_updated** (string) - The date and time when the discount was last updated (ISO 8601 format). #### Response Example ```json [ { "id": 0, "name": "string", "description": "string", "currency_id": 0, "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### GET /system_settings/{Id} Source: https://developer.sage.com/200/professional/2025-r2/general Retrieves a specific system setting by its unique ID. This allows for targeted access to configuration details. ```APIDOC ## GET /system_settings/{Id} ### Description The System Settings are used to define operation and transaction settings. Operational settings includes setting such as the next VAT return date and number of open accounting periods. Transaction settings gives options to use additional transaction analysis and whether to validate transaction dates. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/system_settings/{Id} ### Parameters #### Path Parameters - **Id** (number) - Required - Unique ID of the system settings. #### Query Parameters - **X-Site** (string) - Required - The ID of the site to access. ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the system settings. - **next_urn** (string) - The next VAT return number. - **next_invoice_number** (integer) - The next invoice number. - **next_credit_note_number** (integer) - The next credit note number. - **next_journal_entry_number** (integer) - The next journal entry number. - **first_vat_return_date_defined** (boolean) - Indicates if the first VAT return date is defined. - **first_vat_return_date** (string) - The date of the first VAT return (ISO 8601 format). - **intrastat_value_for_consolidation** (number) - The Intrastat value for consolidation. - **number_open_periods** (integer) - The number of open accounting periods. - **update_nominal_online** (boolean) - Indicates if nominal ledger updates are performed online. - **use_cost_centre_breakdown** (boolean) - Indicates if cost centre breakdown is used. - **use_intrastat_reporting** (boolean) - Indicates if Intrastat reporting is used. - **use_period_exchange_rates** (boolean) - Indicates if period exchange rates are used. - **use_segmented_address** (boolean) - Indicates if segmented addresses are used. - **use_additional_trans_analysis** (boolean) - Indicates if additional transaction analysis is used. - **transaction_analysis_heading** (string) - The heading for transaction analysis. - **accounting_period_validation_type** (string) - The type of accounting period validation. - **financial_year_end_date** (string) - The financial year end date (ISO 8601 format). - **invoice_credit_note_same_numbers** (boolean) - Indicates if invoice and credit note use the same numbering. - **reverse_charge_minimum_value** (number) - The minimum value for reverse charge. - **transaction_date_validation** (object) - Object containing transaction date validation settings. - **id** (integer) - The unique identifier for transaction date validation. - **transaction_date_validation_type** (string) - The type of transaction date validation. - **pre_days_normal** (integer) - Number of pre-days for normal validation. - **post_days_normal** (integer) - Number of post-days for normal validation. - **pre_days_acceptable** (integer) - Number of acceptable pre-days. - **post_days_acceptable** (integer) - Number of acceptable post-days. - **previous_year_classification** (string) - Classification for previous year dates. - **future_year_classification** (string) - Classification for future year dates. - **closed_period_classification** (string) - Classification for closed period dates. - **future_period_classification** (string) - Classification for future period dates. - **date_time_created** (string) - The date and time the validation was created (ISO 8601 format). - **date_time_updated** (string) - The date and time the validation was last updated (ISO 8601 format). - **date_time_created** (string) - The date and time the settings were created (ISO 8601 format). - **date_time_updated** (string) - The date and time the settings were last updated (ISO 8601 format). #### Response Example ```json { "id": 0, "next_urn": "string", "next_invoice_number": 0, "next_credit_note_number": 0, "next_journal_entry_number": 0, "first_vat_return_date_defined": false, "first_vat_return_date": "2019-08-24T14:15:22Z", "intrastat_value_for_consolidation": 0, "number_open_periods": 0, "update_nominal_online": false, "use_cost_centre_breakdown": false, "use_intrastat_reporting": false, "use_period_exchange_rates": false, "use_segmented_address": true, "use_additional_trans_analysis": false, "transaction_analysis_heading": "string", "accounting_period_validation_type": "string", "financial_year_end_date": "2019-08-24T14:15:22Z", "invoice_credit_note_same_numbers": true, "reverse_charge_minimum_value": 0, "transaction_date_validation": { "id": 0, "transaction_date_validation_type": "string", "pre_days_normal": 0, "post_days_normal": 0, "pre_days_acceptable": 0, "post_days_acceptable": 0, "previous_year_classification": "string", "future_year_classification": "string", "closed_period_classification": "string", "future_period_classification": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" }, "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ``` ``` -------------------------------- ### GET /source_of_price_types Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of sources for price types. This specifies whether a discount originates from a Customer, Stock Item, or Product Group discount. ```APIDOC ## GET /source_of_price_types ### Description Retrieves a list of sources for price types. This specifies whether a discount originates from a Customer, Stock Item, or Product Group discount. ### Method GET ### Endpoint /uk/sage200extra/accounts/v1/source_of_price_types ### Response #### Success Response (200) - **id** (number) - The unique identifier for the source of the price type. - **description** (string) - A description of the source. - **value** (string) - The value representing the source. #### Response Example ```json [ { "id": 0, "description": "string", "value": "string" } ] ``` ``` -------------------------------- ### GET /pricing_types Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of available pricing types. This specifies how a price has been calculated, such as from a Unit Price, Unit Discount Value, Unit Discount Percentage, or Special Price. ```APIDOC ## GET /pricing_types ### Description Retrieves a list of available pricing types. This specifies how a price has been calculated, such as from a Unit Price, Unit Discount Value, Unit Discount Percentage, or Special Price. ### Method GET ### Endpoint /uk/sage200extra/accounts/v1/pricing_types ### Response #### Success Response (200) - **id** (number) - The unique identifier for the pricing type. - **description** (string) - A description of the pricing type. - **value** (string) - The value associated with the pricing type. #### Response Example ```json [ { "id": 0, "description": "string", "value": "string" } ] ``` ``` -------------------------------- ### Get Specific Nominal Report Category (GET) Source: https://developer.sage.com/200/professional/2025-r2/nominal Retrieves the details of a specific nominal report category by its unique ID. This is useful for viewing or editing an existing category. The response provides the same details as the list endpoint for the specified category. ```json { "id": 0, "account_report_type": "string", "code": "stri", "description": "string", "account_report_category_type": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ``` -------------------------------- ### Get Nominal Report Categories (GET) Source: https://developer.sage.com/200/professional/2025-r2/nominal Retrieves a list of all nominal report categories. This is useful for understanding the structure of financial statements and how nominal codes are grouped. The response includes details like ID, code, description, and creation/update timestamps. ```json [ { "id": 0, "account_report_type": "string", "code": "stri", "description": "string", "account_report_category_type": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### Get All Order Value Discounts (JSON) Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of all order value discounts. The response includes details such as ID, name, description, and currency information. This endpoint is useful for fetching all discount configurations. ```json [ { "id": 0, "name": "string", "description": "string", "currency_id": 0, "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### Get Price Book Settings (JSON) Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves the Price Book settings for the application. These settings configure the behavior of the Price Book module, including pricing discounts. This endpoint is useful for understanding and managing global price book configurations. -------------------------------- ### GET /customer_discount_groups/{Id} Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves the details of a specific customer discount group by its unique ID. ```APIDOC ## GET /customer_discount_groups/{Id} ### Description Retrieves the details of a specific customer discount group by its unique ID. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customer_discount_groups/{Id} ### Parameters #### Path Parameters - **Id** (number) - Required - The unique ID of the customer discount group. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the customer discount group. - **name** (string) - The name of the customer discount group. - **description** (string) - A description of the customer discount group. - **date_time_created** (string) - The date and time when the customer discount group was created (ISO 8601 format). - **date_time_updated** (string) - The date and time when the customer discount group was last updated (ISO 8601 format). #### Response Example ```json { "id": 0, "name": "string", "description": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ``` #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### GET /customer_price_bands/{Id} Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves the details of a specific customer price band linkage by its unique ID. ```APIDOC ## GET /customer_price_bands/{Id} ### Description Retrieves the details of a specific customer price band linkage by its unique ID. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customer_price_bands/{Id} ### Parameters #### Path Parameters - **Id** (number) - Required - The unique ID of the customer price band linkage. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the customer price band linkage. - **customer_id** (integer) - The ID of the customer. - **price_band_id** (integer) - The ID of the price band. - **is_to_delete** (boolean) - Flag indicating if this linkage should be deleted. - **price_band** (object) - Details of the associated price band (structure not detailed here). - **date_time_created** (string) - The date and time when the linkage was created (ISO 8601 format). - **date_time_updated** (string) - The date and time when the linkage was last updated (ISO 8601 format). #### Response Example ```json { "id": 0, "customer_id": 0, "price_band_id": 0, "is_to_delete": true, "price_band": { }, "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ``` #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### GET /sites Source: https://developer.sage.com/200/professional/2025-r2/general Retrieves a list of sites accessible by the authenticated user. The 'X-Site' header is required for all API resource invocations. ```APIDOC ## GET /sites ### Description Access to Sage 200 sites is restricted by a Sage account. When invoking any API resource, the site Id must always be specified within the header 'X-Site'. Use this API endpoint to return the list of sites that a user has access to. This operation is particularly important during the initial stages of API development. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/sites ### Parameters #### Query Parameters - **X-Site** (string) - Required - The ID of the site to access. ### Response #### Success Response (200) - **company_id** (integer) - The ID of the company. - **company_name** (string) - The name of the company. - **site_id** (string) - The ID of the site. - **site_name** (string) - The name of the site. - **site_short_name** (string) - The short name of the site. #### Response Example ```json [ { "company_id": 0, "company_name": "string", "site_id": "string", "site_name": "string", "site_short_name": "string" } ] ``` ``` -------------------------------- ### Get Sage 200 System Settings (JSON Response Sample) Source: https://developer.sage.com/200/professional/2025-r2/general This JSON array details the system settings for Sage 200, including operational and transaction configurations. It covers settings like VAT return dates, accounting periods, and various validation options. ```json [ { "id": 0, "next_urn": "string", "next_invoice_number": 0, "next_credit_note_number": 0, "next_journal_entry_number": 0, "first_vat_return_date_defined": false, "first_vat_return_date": "2019-08-24T14:15:22Z", "intrastat_value_for_consolidation": 0, "number_open_periods": 0, "update_nominal_online": false, "use_cost_centre_breakdown": false, "use_intrastat_reporting": false, "use_period_exchange_rates": false, "use_segmented_address": true, "use_additional_trans_analysis": false, "transaction_analysis_heading": "string", "accounting_period_validation_type": "string", "financial_year_end_date": "2019-08-24T14:15:22Z", "invoice_credit_note_same_numbers": true, "reverse_charge_minimum_value": 0, "transaction_date_validation": { "id": 0, "transaction_date_validation_type": "string", "pre_days_normal": 0, "post_days_normal": 0, "pre_days_acceptable": 0, "post_days_acceptable": 0, "previous_year_classification": "string", "future_year_classification": "string", "closed_period_classification": "string", "future_period_classification": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" }, "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### GET /flow_states Source: https://developer.sage.com/200/professional/2025-r2/general Retrieves a list of states for Microsoft Flow. ```APIDOC ## GET /flow_states ### Description Retrieves a list of states for Microsoft Flow. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/flow_states ### Response #### Success Response (200) - An array of flow state objects, each containing: - **id** (number) - The unique identifier of the flow state. - **flow_id** (string) - The Microsoft Flow identifier. - **value** (string) - The value of the flow state. - **date_time_created** (string) - The date and time when the flow state was created (ISO 8601 format). - **date_time_updated** (string) - The date and time when the flow state was last updated (ISO 8601 format). #### Response Example ```json [ { "id": 0, "flow_id": "string", "value": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` ``` -------------------------------- ### GET /current_user Source: https://developer.sage.com/200/professional/2025-r2/general Retrieves details of the currently logged-in user. ```APIDOC ## GET /current_user ### Description Retrieves details of the currently logged-in user. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/current_user ### Response #### Success Response (200) - **id** (number) - The unique identifier of the user. - **logon_name** (string) - The logon name of the user. - **friendly_name** (string) - The friendly name of the user. - **email_address** (string) - The email address of the user. - **is_web_user** (boolean) - Indicates if the user is a web user. - **last_logon_date_time** (string) - The date and time of the last logon (ISO 8601 format). #### Response Example ```json { "id": 0, "logon_name": "string", "friendly_name": "string", "email_address": "string", "is_web_user": true, "last_logon_date_time": "2019-08-24T14:15:22Z" } ``` ``` -------------------------------- ### Get All Price Bands (JSON) Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of all price bands. Price bands are used to set different prices for different customers. The response includes details like ID, name, description, currency, and activation status. ```json [ { "id": 0, "name": "string", "description": "string", "is_standard_band": true, "currency_id": 0, "price_band_type_id": 0, "price_band_type": "string", "is_active": true, "is_time_based": true, "active_date_time_from": "2019-08-24T14:15:22Z", "active_date_time_to": "2019-08-24T14:15:22Z", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### Response Sample: JSON for Configurable Terms Source: https://developer.sage.com/200/professional/2025-r2/general This JSON array represents the response for retrieving configurable terms for the application. Each object contains keys for singular and plural forms of terms. ```json [ { "key": "string", "lower_case_single": "string", "lower_case_plural": "string", "upper_case_single": "string", "upper_case_plural": "string" } ] ``` -------------------------------- ### Get Users (JSON Response Sample) Source: https://developer.sage.com/200/professional/2025-r2/general This snippet provides a sample JSON response for the 'get/users' endpoint, which returns a list of users. Each user object contains their ID and name. ```json [ { "id": 0, "name": "string" } ] ``` -------------------------------- ### GET /price_bands Source: https://developer.sage.com/200/professional/2025-r2/price-book Retrieves a list of all price bands. A price band is a price list used to offer different prices to different customers. ```APIDOC ## GET /price_bands ### Description Retrieves a list of all price bands. A price band is a price list used to offer different prices to different customers. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/price_bands ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the price band. - **name** (string) - The name of the price band. - **description** (string) - A description of the price band. - **is_standard_band** (boolean) - Indicates if this is the standard price band. - **currency_id** (integer) - The ID of the currency associated with the price band. - **price_band_type_id** (integer) - The ID of the price band type. - **price_band_type** (string) - The description of the price band type. - **is_active** (boolean) - Indicates if the price band is currently active. - **is_time_based** (boolean) - Indicates if the price band is time-based. - **active_date_time_from** (string) - The start date and time for the price band's active period (ISO 8601 format). - **active_date_time_to** (string) - The end date and time for the price band's active period (ISO 8601 format). - **date_time_created** (string) - The date and time when the price band was created (ISO 8601 format). - **date_time_updated** (string) - The date and time when the price band was last updated (ISO 8601 format). #### Response Example ```json [ { "id": 0, "name": "string", "description": "string", "is_standard_band": true, "currency_id": 0, "price_band_type_id": 0, "price_band_type": "string", "is_active": true, "is_time_based": true, "active_date_time_from": "2019-08-24T14:15:22Z", "active_date_time_to": "2019-08-24T14:15:22Z", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` #### Error Response (400) - **message** (string) - Details about the problem with the request. ``` -------------------------------- ### General Settings API Source: https://developer.sage.com/200/professional/200/reference Access essential configurations like accounting period validation types, system settings, and company information. ```APIDOC ## General Settings API ### Description Endpoints for accessing and managing general system configurations, including accounting period validation types, system settings, and company details. ### Method GET, POST, PUT (specific methods depend on the operation) ### Endpoint /api/sage200/general ### Parameters (Specific parameters will vary based on the operation, e.g., setting name, period type) ### Request Example (Example request body for updating a system setting) ```json { "settingName": "DefaultLanguage", "settingValue": "en-GB" } ``` ### Response #### Success Response (200) - **settingUpdated** (boolean) - Indicates if the setting was updated. - **message** (string) - Confirmation message. #### Response Example ```json { "settingUpdated": true, "message": "System setting updated successfully." } ``` ``` -------------------------------- ### GET /consolidated_nominal_codes/{Id} Source: https://developer.sage.com/200/professional/2025-r2/nominal Retrieves the details of a specific consolidated nominal code by its ID. ```APIDOC ## GET /consolidated_nominal_codes/{Id} ### Description Retrieves the details of a specific consolidated nominal code by its ID. Consolidated nominal codes are used for consolidating accounts from subsidiary ledgers. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/consolidated_nominal_codes/{Id} ### Parameters #### Path Parameters - **Id** (number) - Required - The unique ID of the consolidated nominal code. ### Request Example None ### Response #### Success Response (200) - **id** (integer) - The ID of the nominal code. - **name** (string) - The name of the nominal code. - **reference** (string) - The reference of the nominal code. - **cost_centre_id** (integer) - The ID of the associated cost centre. - **cost_centre_code** (string) - The code of the associated cost centre. - **department_id** (integer) - The ID of the associated department. - **department_code** (string) - The code of the associated department. - **nominal_account_type** (string) - The type of the nominal account. - **account_status_type** (string) - The status of the account (e.g., "AccountStatusActive"). - **date_time_created** (string) - The date and time the nominal code was created (ISO 8601 format). - **date_time_updated** (string) - The date and time the nominal code was last updated (ISO 8601 format). #### Response Example ```json { "id": 0, "name": "string", "reference": "string", "cost_centre_id": 0, "cost_centre_code": "str", "department_id": 0, "department_code": "str", "nominal_account_type": "string", "account_status_type": "AccountStatusActive", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ``` #### Error Response (400) - **message** (string) - A message describing the error. ``` -------------------------------- ### Get Pending Emails Source: https://developer.sage.com/200/professional/2025-r2/general Retrieves a list of all pending emails that can be used with Microsoft Flow. ```APIDOC ## GET /pending_emails ### Description Retrieves a list of all pending emails that can be used with Microsoft Flow. ### Method GET ### Endpoint https://api.columbus.sage.com/uk/sage200extra/accounts/v1/pending_emails ### Responses #### Success Response (200) Returns a list of all pending emails. #### Response Example (200) ```json [ { "id": 0, "email_type": "string", "email_address": "string", "email_subject": "string", "email_body": "string", "user_number": 0, "user_name": "string", "date_time_created": "2019-08-24T14:15:22Z", "date_time_updated": "2019-08-24T14:15:22Z" } ] ``` #### Error Response (400) There was a problem with the request. Request body will include details. ```