Skip to main content

Sage 200 Component

Sage 200 is an online business management solution designed to help businesses manage their finances, customers, and business insight in one solution.

Component key: sage-200 ·
· Changelog ↓

Description​

Sage 200 is an online business management solution designed to help businesses manage their finances, customers, and business insight in one solution.

Use the Sage 200 component to manage Customers, Products, and Pricing.

API Documentation​

This component is built to the Sage 200 Professional/Extra Online API Reference.

Connections​

Sage 200 OAuth 2.0 Connection​

key: sage200Oauth2Connection

Connection and Authentication​

To generate a token, your application requires a Client ID and Client Secret please contact the Sage Developer Services team by emailing developers.programme@sage.com along with the following information:

  • Application name.
  • Application description.
  • Description of use i.e. In-house or publication for resale.
  • Type of application i.e. Public Client (Desktop, Mobile application) or Confidential (Web Server). If the type is a Confidential Client application you must supply your "Redirect Url".
    • For integrations the details will be - Confidential (Web Server). Redirect URI: https://oauth2.prismatic.io/callback

Sage will then confirm your request and have you submit the following form. Once completed, It may take Sage a few days to process the request but you will eventually receive credentials for the integration connection configuration.

Native API access via Microsoft Entra ID/Active Directory Tunnelling​

Some instances may require tunnelling their Sage 200 server to a Microsoft 365 account in order to run Native API calls for local servers. Please refer to the Set up the Sage 200 Native API using Microsoft Entra ID Azure Active Directory Tunnelling for detailed instruction. Additionally, the following onboarding video details the steps of the setup process.

InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Sage 200

https://id.sage.com/authorize?audience=s200ukipd/sage200
Client ID
Client Secret
Ocp Apim Subscription Key

You can get your subscription key following the steps at 'Obtain Developer Subscription Keys' here: https://developer.sage.com/200/api/get-started/

Sage 200 Edition

The Sage 200 Edition you are connecting to.

Scopes

A space-delimited set of one or more scopes to get the user's permission to access.

openid profile email offline_access
Token URL

The OAuth 2.0 Token URL for Sage 200

https://id.sage.com/oauth/token

Triggers​

New and Updated Records​

Checks for new and updated records in Sage 200 on a configured schedule. | key: pollChangesTrigger

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Resource Type

The Sage 200 resource type to poll for new or updated records.

Show New Records

When true, newly created records are included in the trigger output.

true
Show Updated Records

When true, records updated after the last poll are included in the trigger output.

true
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a

This trigger polls the Sage 200 Professional/Extra Online API for new and updated records of the selected resource type on a configured schedule.

How It Works​

  1. The trigger runs on the configured schedule (e.g., every 5 minutes)
  2. On each execution, records of the selected resource type are fetched from Sage 200 using the corresponding list endpoint with a server-side OData filter ($filter=date_time_updated gt {lastPolledAt}) so only records changed since the previous poll are returned
  3. Returned records are categorized client-side as created or updated by comparing each record's date_time_created and date_time_updated against the timestamp of the last successful poll
  4. A record is classified as created when date_time_created is newer than the last poll time; otherwise, when date_time_updated is newer than the last poll time, the record is classified as updated (created beats updated)
  5. The trigger updates its internal state with the current timestamp after each poll so subsequent executions only surface records changed since the previous run
  6. When no records match on a given run, the trigger reports polledNoChanges so downstream flows are not invoked unnecessarily
  7. On the very first execution, lastPolledAt defaults to the current time so no historical records flood the workflow — only changes that occur after the trigger is enabled will be surfaced

Supported Resource Types​

Available Resources (9)
Resource TypeEndpoint
Customers/customers
Customer Contacts/customer_contacts
Customer Delivery Addresses/customer_delivery_addresses
Customer Price Bands/customer_price_bands
Price Bands/price_bands
Products/products
Product Groups/product_groups
Sales Orders/sop_orders
Tax Codes/tax_codes

Configuration​

Configure the following inputs:

Available Inputs (6)
  • Connection: The Sage 200 connection used to authenticate API requests
  • Site: The site ID. This value can be obtained from the Get Site and Company Information action
  • Company: The company ID. This value can be obtained from the Get Site and Company Information action
  • Resource Type: The Sage 200 resource type to poll for new or updated records
  • Show New Records: When enabled, newly created records are included in the trigger output. Defaults to true
  • Show Updated Records: When enabled, records updated after the last poll are included in the trigger output. Defaults to true

Returned Data​

The trigger returns an object containing two arrays — created for newly created records and updated for modified records. Each array contains full Sage 200 resource objects matching the selected resource type.

Example Response
{
  "data": {
    "created": [
      {
        "id": "a1b2c3d4-1234-5678-90ab-cdef12345678",
        "code": "CUST001",
        "name": "Acme Corporation",
        "date_time_created": "2026-04-27T10:15:00Z",
        "date_time_updated": "2026-04-27T10:15:00Z"
      }
    ],
    "updated": [
      {
        "id": "e5f6g7h8-9012-3456-78ab-cdef90123456",
        "code": "CUST002",
        "name": "Globex Industries",
        "date_time_created": "2026-03-15T08:00:00Z",
        "date_time_updated": "2026-04-27T11:42:00Z"
      }
    ]
  }
}

Notes​

  • The trigger sends lastPolledAt directly to the Sage 200 OData $filter query as an ISO 8601 string (e.g. 2026-04-27T10:00:00Z). The API parses the ISO string directly — no datetime literal wrapping is required
  • When both Show New Records and Show Updated Records are disabled, the trigger short-circuits without calling the API and reports polledNoChanges
  • A record qualifying as both new and updated is reported as created (created beats updated) so downstream flows do not process the same record twice on the run it first appears
  • Refer to the Sage 200 Professional/Extra Online API Reference for rate limit details and the full set of fields available on each resource type

Data Sources​

Select Customer​

Select a customer from a dropdown list | key: selectCustomer | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Customer⤓
Loading…

Select Customer Contact​

Select a customer contact from a dropdown list. | key: selectCustomerContact | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Customer Contact⤓
Loading…

Select Customer Delivery Address​

Select a customer delivery address from a dropdown list. | key: selectCustomerDeliveryAddress | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Customer Delivery Address⤓
Loading…

Select Price Band​

Select a price band from a dropdown list. | key: selectPriceBand | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Price Band⤓
Loading…

Select Product​

Select a product from a dropdown list. | key: selectProduct | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Product⤓
Loading…

Select Product Group​

Select a product group from a dropdown list | key: selectProductGroup | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Product Group⤓
Loading…

Select Sales Order​

Select a sales order from a dropdown list. | key: selectSalesOrder | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Sales Order⤓
Loading…

Select Tax Code​

Select a tax code from a dropdown list | key: selectTaxCode | type: picklist

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Select Tax Code⤓
Loading…

Actions​

Create Customer​

Create a new customer | key: createCustomer

InputNotesExample
Account Status Type

The status of the customer account (Sage 200 Standard and versions of Professional released after July 2017). See Sage 200 API documentation for more information.

AccountStatusActive
Additional Fields

Additional fields that are not covered by the standard inputs. See Sage 200 API documentation for more information.

{
  "credit_limit": 30
}
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Currency ID

Currency record Id. This defaults to the base currency Id. See Sage 200 API documentation for more information.

2103
Exchange Rate Type

The type of exchange rate used on the customer account. See Sage 200 API documentation for more information.

ExchangeRateSingle
Fax Area Code

Fax area code.

806
Fax Country Code

Fax country code.

+1
Fax Subscriber Number

Fax subscriber number.

123-4567
Name

Customer name.

John Doe
On Hold

True if customer account is on hold, else False.

false
Reference

Customer account reference. Note: For Sage 200 Professional this is not required if customer reference is set to 'generate automatically' inside the Sage 200 application settings.

ref-1234
Short Name

Customer short name.

John
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Status Reason

Reason for change in account status.

Suspended due to non-payment
Telephone Area Code

Telephone area code.

806
Telephone Country Code

Telephone country code.

+1
Telephone Subscriber Number

Telephone subscriber number.

123-4567
Website

Website address.

https://www.example.com
Example Payload for Create Customer⤓
Loading…

Create Customer Delivery Address​

Create a new customer delivery address | key: createCustomerDeliveryAddress

InputNotesExample
Address 1

Address line 1.

1 High Street
Address 2

Address line 2.

2 Low Street
Address 3

Address line 3.

3 Middle Street
Address 4

Address line 4.

4 Side Street
Address Country Code Id

Country code Id. See Sage 200 API documentation for more information.

0
City

City (if using segmented addresses in Sage 200 Professional).

Albany
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Contact

The contact associated with the customer delivery address.

Peter Young
Country Code Id

VAT details Country code Id. See Sage 200 API documentation for more information.

13
County

County (if using segmented addresses in Sage 200 Professional).

Brown County
Customer Id

Unique Id of the customer account the customer delivery address is associated with.

27912
Description

The description of the customer delivery address.

Home Address
Email

The email address associated with the customer delivery address.

pyoung@hobotmail.com
Fax

The fax number associated with the customer delivery address.

08976 656 878
Is Default

Flag to indicate if this is the default customer delivery address for the parent customer.

false
Postal Name

Postal name is the name of the person or company who the invoice or sales order is addressed to.

Peter Young
Postcode

Postcode.

12345
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Tax Code Id

The tax code record Id.

1729
Tax Number

The tax number.

9NN-NN-NNNN
Telephone

The telephone number associated with the customer delivery address.

08976 656 878
Example Payload for Create Customer Delivery Address⤓
Loading…

Create Product​

Create a new product | key: createProduct

InputNotesExample
Additional Fields

Additional fields that are not covered by the standard inputs. See Sage 200 API documentation for more information.

{
  "warehouse_holdings": [
    {
      "warehouse_id": "34627",
      "reorder_level": "1",
      "minimum_level": "1",
      "maximum_level": "1",
      "quantity_in_stock": 0,
      "is_default_manufacturing_warehouse": true,
      "id": 0,
      "bin_holdings": [
        {
          "name": "Unspecified",
          "allocation_priority": 9,
          "id": 0
        }
      ]
    }
  ]
}
Allow Duplicate Numbers

Indicates whether the product allows duplicate numbers. (Sage 200 Professional only).

false
Allow Sales Order

Indicates whether the product is allowed on sales orders and invoicing.

true
Product Barcode

Product bar code.

1234567890123
Product Code

Product code.

VID003
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Product Description

Product description.

32mb PCI Video Card
Fulfilment Method Type

The fulfilment method type of the product. See Sage 200 API documentation for more information.

EnumFulfilmentFromStock
Fulfilment Sequence Type

The fulfilment sequence type of the product. See Sage 200 API documentation for more information.

EnumBinPriority
Inactivation Date

If the product was made inactive, the date on which the product was made inactive.

2024-02-28T14:06:51.697Z
Label Printing Option Type

The label printing option type. (Sage 200 Professional only). See Sage 200 API documentation for more information.

EnumNotRequired
Manufacturer

The product manufacturer.

Nvidia
Product Name

Product name.

32mb PCI Video Card
Part Number

The product part number.

VI6874
Product Group ID

Product group record Id. See Sage 200 API documentation for more information.

34646
Product Status Type

The product status type. See Sage 200 API documentation for more information.

EnumStockItemStatusTypeActive
Sale From Single Batch

Indicates whether the product is sold from a single batch. (Sage 200 Professional only).

false
Shelf Life

The shelf life of the product. (Sage 200 Professional only).

Shelf Life Type

The shelf life type of the product. (Sage 200 Professional only). See Sage 200 API documentation for more information.

EnumTimeUnitDay
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Tax Code ID

Tax code record Id. See Sage 200 API documentation for more information.

1729
Traceable Type

The traceable type of the product. (Sage 200 Professional only). See Sage 200 API documentation for more information.

EnumTraceableTypeNone
Use Description On Documents

Whether to use the product description on order and invoice documents.

false
Uses Alternative Reference

Indicates whether the product uses alternative references. (Sage 200 Professional only).

false
Uses Sell By Date

Indicates whether the product uses sell by dates. (Sage 200 Professional only).

false
Uses Use By Date

Indicates whether the product uses use by dates. (Sage 200 Professional only).

false
Example Payload for Create Product⤓
Loading…

Create Sales Invoice​

Create a new sales invoice. Note: Posting a sales invoice does not actually create a 'sales invoice' entity, but a Posted Transaction of type 'TradingAccountEntryTypeInvoice', therefore it is not possible to 'get' a sales invoice using the same API endpoint after it has been posted. | key: createSalesInvoice

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer ID

Customer record ID to record a sale against. See Sage 200 API documentation for more information.

27825
Discount Days

Number of days to pay to qualify for the settlement discount. This defaults to the settlement days from the customer record.

3
Discount Percent

Percentage discount. This defaults to the settlement discount from the customer record.

15.00
Document Discount Value

Discount value.

4.00
Document Goods Value

Value of goods.

10.00
Document Tax Discount Value

Amount VAT is discounted when a settlement discount is applied.

5.00
Document Tax Value

Tax value.

2.00
Due Date

Date the invoice is due to be paid.

2023-01-02T00:00:00Z
Exchange Rate

Exchange rate for the invoice. This defaults to the customer exchange rate.

ExchangeRateSingle
Nominal Analysis Items

Nominal analysis lines. See Sage 200 API documentation for more information.

[
  {
    "code": "123",
    "narrative": "Example narrative"
  }
]
Reference

Invoice reference.

ABCDE
Second Reference

Invoice second reference.

FGHIJ
Settled Immediately

When set to True this indicates that the invoice has been paid and any settlement discount has been applied.

false
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Tax Analysis Items

Tax analysis lines. See Sage 200 API documentation for more information.

[
  {
    "id": 1,
    "goods_amount": 12.15
  }
]
Transaction Date

Transaction date. This defaults to the current system date.

2023-01-02T00:00:00Z
Triangular Transaction

Indicates whether the transaction is triangluted.

false
Example Payload for Create Sales Invoice⤓
Loading…

Create Sales Order​

Create a new sales order | key: createSalesOrder

InputNotesExample
Additional Fields

Additional fields that are not covered by the standard inputs. See Sage 200 API documentation for more information.

{
  "available_document_discount_percent": 20
}
Apply Available Document Discount Percent

This should be passed within to apply the 'available_document_discount_percent' to the sales order only if the 'available_document_discount_percent' is greater than a positive 'Document Discount Percent'.

false
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer Delivery Address ID

The Id of the customer delivery address to copy details to the sales order delivery address and resets 'Use Invoice Address'. See Sage 200 API documentation for more information.

27912
Customer Document Number

Customer document number.

0000000001
Customer ID

Customer record ID to create the sales order for.

27903
Customer Type

SOP customer type. See Sage 200 API documentation for more information.

EnumCustomerTypeCredit
Document Created By

The person who created the sales order.

John Doe
Document Date

Sales order document date.

2023-01-02T00:00:00Z
Document Discount Percent

Document discount percent value, between -99.99 and 99.99. A negative value is treated as a surcharge (e.g. -10 is a 10% surcharge), and a positive value is treated as a discount.

0
Document Number

Sales order document number. If the SOP setting in Sage 200 Professional is to NOT automatically generate numbers, then this property MUST be set. If the SOP setting in Sage 200 Professional is to automatically generate numbers, or you are using Sage 200 Standard (which doesn't allow you to set this option), then setting this will be ignored.

123
Exchange Rate

Exchange rate.

1
Is Editing

If this is set to true, and the order is still a draft order, the order will remain as a draft order, otherwise the order is made a confirmed order.

false
Is To Sequence Lines

If this is set to true, then the order of the line objects in the lines collection will determine the line number (print sequence number) for each line.

false
Is Triangulated

Whether this order is triangulated and applies only to an EU customer with a different country code to that set in the company details.

false
Order Priority

Order priority.

2
Override On Hold

Allows a user that has the permissions to override the order's On Hold status, applied when a customer's account balance is over its credit limit.

false
Promised Delivery Date

Promised delivery date.

2024-02-28T14:06:55.723Z
Quotation Expiry Date

Quotation expiry date (only used for quotations).

2024-02-28T14:06:55.723Z
Recalculate Prices

Allows recalculation of the prices for the order when the exchange rate has changed.

false
Requested Delivery Date

Requested delivery date.

2024-02-28T14:06:55.723Z
Settlement Discount Days

Settlement discount days.

30
Settlement Discount Percent

Settlement discount percent.

2.5
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Suppress Warnings

If this is set to true, we will suppress warnings specifically for payment with order and this is also the case if 'Is Editing' is false.

false
Use Invoice Address

True if this order uses the customer invoice address, else False.

false
Example Payload for Create Sales Order⤓
Loading…

Delete Customer​

Delete a customer by ID | key: deleteCustomer

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer ID

The ID of the customer to delete.

82060
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Delete Customer⤓
Loading…

Delete Customer Contact​

Delete a customer contact | key: deleteCustomerContact

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer Contact ID

The ID of the customer contact to delete

27914
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Delete Customer Contact⤓
Loading…

Delete Customer Delivery Address​

Delete a customer delivery address by ID | key: deleteCustomerDeliveryAddress

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Delivery Address ID

The ID of the customer delivery addresses to delete.

82780
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Delete Customer Delivery Address⤓
Loading…

Delete Product​

Delete a product by ID | key: deleteProduct

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Product ID

The ID of the product to delete.

35738
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Delete Product⤓
Loading…

Delete Sales Order​

Delete an existing sales order by ID | key: deleteSalesOrder

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Sales Order ID

Sales order ID to delete

81390
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Delete Sales Order⤓
Loading…

Get Customer​

Retrieve a customer by ID | key: getCustomer

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer ID

The ID of the customer to retrieve.

82060
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Customer⤓
Loading…

Get Customer Contact​

Retrieve a customer contact by ID | key: getCustomerContact

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer Contact ID

The ID of the customer contact to retrieve

27914
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Customer Contact⤓
Loading…

Get Customer Delivery Address​

Retrieve customer delivery address by ID | key: getCustomerDeliveryAddress

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Delivery Address ID

The ID of the customer delivery addresses to retrieve.

82780
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Customer Delivery Address⤓
Loading…

Get Customer Price Band​

Retrieve a customer price band by ID | key: getCustomerPriceBand

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer Price Band ID

The ID of the customer price band to retrieve

1064
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Customer Price Band⤓
Loading…

Get Items on a Sales Order​

Retrieve a list of items attached to a sales order | key: getItemsOnSalesOrder

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Order Line ID

The Sales Order Line ID. This can be found in the Sales Order Line 'lines' array attribute.

38292
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Items on a Sales Order⤓
Loading…

Get Price Band​

Retrieve a price band by ID | key: getPriceBand

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Price Band ID

The ID of the price band to retrieve

1064
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Price Band⤓
Loading…

Get Product​

Retrieve a product by ID | key: getProduct

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Product ID

The ID of the product to retrieve.

35738
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Product⤓
Loading…

Get Product Group​

Retrieve a product group by ID | key: getProductGroup

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Product Group ID

The ID of the product group to retrieve.

34634
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Product Group⤓
Loading…

Get Product Price Views​

Returns the selling prices of your products. A price is returned for each price band associated with a product. | key: getProductPriceViews

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Product Price Views⤓
Loading…

Get Sales Invoice, Return, and Credit Views​

Retrieve a view of sales orders and returns and invoices and credit notes. | key: getSalesInvoiceReturnCreditViews

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Sales Invoice, Return, and Credit Views⤓
Loading…

Get Sales Order​

Retrieve an existing sales order by ID | key: getSalesOrder

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Sales Order ID

Sales order ID to retrieve

38294
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Get Sales Order⤓
Loading…

Get Site and Company Information​

Get Site and Company ID's information for all sites the authenticated user has access to. | key: getSiteAndCompanyInformation

InputNotesExample
Connection
Example Payload for Get Site and Company Information⤓
Loading…

Get Tax Code​

Retrieve a tax code by ID | key: getTaxCode

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Tax Code ID

The ID of the tax code to retrieve

16
Example Payload for Get Tax Code⤓
Loading…

List Customer Contacts​

Retrieve a list of customer contacts | key: listCustomerContacts

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Customer Contacts⤓
Loading…

List Customer Delivery Addresses​

Retrieve a list of customer delivery addresses | key: listCustomerDeliveryAddresses

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Customer Delivery Addresses⤓
Loading…

List Customer Price Bands​

Retrieve a list of customer price bands | key: listCustomerPriceBands

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Customer Price Bands⤓
Loading…

List Customers​

Retrieve a list of all customers | key: listCustomers

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Customers⤓
Loading…

List Price Bands​

Retrieve a list of price bands | key: listPriceBands

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Price Bands⤓
Loading…

List Pricing Source Types​

Retrieve a list of pricing source types | key: listPricingSourceTypes

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Pricing Source Types⤓
Loading…

List Pricing Types​

Retrieve a list of pricing types | key: listPricingTypes

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Pricing Types⤓
Loading…

List Product Groups​

Retrieve a list of product groups | key: listProductGroups

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Product Groups⤓
Loading…

List Products​

Retrieve a list of products | key: listProducts

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Products⤓
Loading…

List Sales Order​

Retrieve a list of sales orders | key: listSalesOrder

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Sales Order⤓
Loading…

List Tax Codes​

Retrieve a list of tax codes | key: listTaxCodes

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Filter Data After Date

Filter data to only include items that have been updated after this date.

2021-01-01T00:00:00Z
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for List Tax Codes⤓
Loading…

Raw Request​

Send raw HTTP request to Sage 200 | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request. Subscription key and Authorization headers are already included.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/sites), The base URL is already included (https://api.columbus.sage.com/uk/sage200extra/accounts/v1). For example, to connect to https://api.columbus.sage.com/uk/sage200extra/accounts/v1/sites, only /sites is entered in this field.

/sites
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Search Customers​

Search customer list | key: searchCustomers

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Search Customers⤓
Loading…

Search Product Groups​

Search the list of product groups | key: searchProductGroups

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Search Product Groups⤓
Loading…

Search Products​

Search the list of products | key: searchProducts

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Example Payload for Search Products⤓
Loading…

Update Customer​

Edit an existing customer | key: updateCustomer

InputNotesExample
Account Status Type

The status of the customer account (Sage 200 Standard and versions of Professional released after July 2017). See Sage 200 API documentation for more information.

AccountStatusActive
Additional Fields

Additional fields that are not covered by the standard inputs. See Sage 200 API documentation for more information.

{
  "credit_limit": 30
}
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Currency ID

Currency record Id. This defaults to the base currency Id. See Sage 200 API documentation for more information.

2103
Customer ID

The ID of the customer to update.

82060
Exchange Rate Type

The type of exchange rate used on the customer account. See Sage 200 API documentation for more information.

ExchangeRateSingle
Fax Area Code

Fax area code.

806
Fax Country Code

Fax country code.

+1
Fax Subscriber Number

Fax subscriber number.

123-4567
On Hold

True if customer account is on hold, else False.

undefined
Short Name

Customer short name.

John
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Status Reason

Reason for change in account status.

Suspended due to non-payment
Telephone Area Code

Telephone area code.

806
Telephone Country Code

Telephone country code.

+1
Telephone Subscriber Number

Telephone subscriber number.

123-4567
Website

Website address.

https://www.example.com
Example Payload for Update Customer⤓
Loading…

Update Customer Contact​

Edit an existing customer contact by ID | key: updateCustomerContact

InputNotesExample
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer ID

The ID of the customer contact to update

27914
Emails

An array of customer emails. See Sage 200 API documentation for more information.

Faxes

An array of customer faxes. See Sage 200 API documentation for more information.

First Name

Contact first name.

John
Is To Delete

When updating an existing customer, whether to delete this contact from the collection of customer contacts.

undefined
Last Name

Contact surname.

Smith
Middle Name

Contact middle name.

Doe
Mobiles

An array of customer mobiles. See Sage 200 API documentation for more information.

Roles

An array of customer contact roles. See Sage 200 API documentation for more information.

Salutation ID

Salutation record Id.

0
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Telephones

An array of customer telephones. See Sage 200 API documentation for more information.

Websites

An array of customer websites. See Sage 200 API documentation for more information.

Example Payload for Update Customer Contact⤓
Loading…

Update Customer Delivery Address​

Edit an existing customer delivery address by ID | key: updateCustomerDeliveryAddress

InputNotesExample
Address 1

Address line 1.

1 High Street
Address 2

Address line 2.

2 Low Street
Address 3

Address line 3.

3 Middle Street
Address 4

Address line 4.

4 Side Street
Address Country Code Id

Country code Id. See Sage 200 API documentation for more information.

0
City

City (if using segmented addresses in Sage 200 Professional).

Albany
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Contact

The contact associated with the customer delivery address.

Peter Young
Country Code Id

VAT details Country code Id. See Sage 200 API documentation for more information.

13
County

County (if using segmented addresses in Sage 200 Professional).

Brown County
Delivery Address ID

The ID of the customer delivery addresses to update.

82780
Email

The email address associated with the customer delivery address.

pyoung@hobotmail.com
Fax

The fax number associated with the customer delivery address.

08976 656 878
Is Default

Flag to indicate if this is the default customer delivery address for the parent customer.

undefined
Postal Name

Postal name is the name of the person or company who the invoice or sales order is addressed to.

Peter Young
Postcode

Postcode.

12345
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Tax Number

The tax number.

9NN-NN-NNNN
Telephone

The telephone number associated with the customer delivery address.

08976 656 878
Example Payload for Update Customer Delivery Address⤓
Loading…

Update Product​

Edit an existing product by ID | key: updateProduct

InputNotesExample
Additional Fields

Additional fields that are not covered by the standard inputs. See Sage 200 API documentation for more information.

{
  "warehouse_holdings": [
    {
      "warehouse_id": "34627",
      "reorder_level": "1",
      "minimum_level": "1",
      "maximum_level": "1",
      "quantity_in_stock": 0,
      "is_default_manufacturing_warehouse": true,
      "id": 0,
      "bin_holdings": [
        {
          "name": "Unspecified",
          "allocation_priority": 9,
          "id": 0
        }
      ]
    }
  ]
}
Allow Duplicate Numbers

Indicates whether the product allows duplicate numbers. (Sage 200 Professional only).

undefined
Allow Sales Order

Indicates whether the product is allowed on sales orders and invoicing.

undefined
Product Barcode

Product bar code.

1234567890123
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Product Description

Product description.

32mb PCI Video Card
Fulfilment Method Type

The fulfilment method type of the product. See Sage 200 API documentation for more information.

EnumFulfilmentFromStock
Fulfilment Sequence Type

The fulfilment sequence type of the product. See Sage 200 API documentation for more information.

EnumBinPriority
Inactivation Date

If the product was made inactive, the date on which the product was made inactive.

2024-02-28T14:06:51.697Z
Label Printing Option Type

The label printing option type. (Sage 200 Professional only). See Sage 200 API documentation for more information.

EnumNotRequired
Manufacturer

The product manufacturer.

Nvidia
Part Number

The product part number.

VI6874
Product ID

The ID of the product to update.

35738
Product Status Type

The product status type. See Sage 200 API documentation for more information.

EnumStockItemStatusTypeActive
Sale From Single Batch

Indicates whether the product is sold from a single batch. (Sage 200 Professional only).

undefined
Shelf Life

The shelf life of the product. (Sage 200 Professional only).

Shelf Life Type

The shelf life type of the product. (Sage 200 Professional only). See Sage 200 API documentation for more information.

EnumTimeUnitDay
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Tax Code ID

Tax code record Id. See Sage 200 API documentation for more information.

1729
Traceable Type

The traceable type of the product. (Sage 200 Professional only). See Sage 200 API documentation for more information.

EnumTraceableTypeNone
Use Description On Documents

Whether to use the product description on order and invoice documents.

undefined
Uses Alternative Reference

Indicates whether the product uses alternative references. (Sage 200 Professional only).

undefined
Uses Sell By Date

Indicates whether the product uses sell by dates. (Sage 200 Professional only).

undefined
Uses Use By Date

Indicates whether the product uses use by dates. (Sage 200 Professional only).

undefined
Example Payload for Update Product⤓
Loading…

Update Sales Order​

Edit an existing sales Order by ID | key: updateSalesOrder

InputNotesExample
Additional Fields

Additional fields that are not covered by the standard inputs. See Sage 200 API documentation for more information.

{
  "available_document_discount_percent": 20
}
Apply Available Document Discount Percent

This should be passed within to apply the 'available_document_discount_percent' to the sales order only if the 'available_document_discount_percent' is greater than a positive 'Document Discount Percent'.

undefined
Company

The company ID. You can get and reference this value from the 'Get Site and Company Information' action.

14123
Connection
Customer Delivery Address ID

The Id of the customer delivery address to copy details to the sales order delivery address and resets 'Use Invoice Address'. See Sage 200 API documentation for more information.

27912
Customer Document Number

Customer document number.

0000000001
Customer Type

SOP customer type. See Sage 200 API documentation for more information.

EnumCustomerTypeCredit
Document Created By

The person who created the sales order.

John Doe
Document Date

Sales order document date.

2023-01-02T00:00:00Z
Document Discount Percent

Document discount percent value, between -99.99 and 99.99. A negative value is treated as a surcharge (e.g. -10 is a 10% surcharge), and a positive value is treated as a discount.

0
Exchange Rate

Exchange rate.

1
Is Editing

If this is set to true, and the order is still a draft order, the order will remain as a draft order, otherwise the order is made a confirmed order.

undefined
Is To Sequence Lines

If this is set to true, then the order of the line objects in the lines collection will determine the line number (print sequence number) for each line.

undefined
Is Triangulated

Whether this order is triangulated and applies only to an EU customer with a different country code to that set in the company details.

undefined
Order Priority

Order priority.

2
Override On Hold

Allows a user that has the permissions to override the order's On Hold status, applied when a customer's account balance is over its credit limit.

undefined
Promised Delivery Date

Promised delivery date.

2024-02-28T14:06:55.723Z
Quotation Expiry Date

Quotation expiry date (only used for quotations).

2024-02-28T14:06:55.723Z
Recalculate Prices

Allows recalculation of the prices for the order when the exchange rate has changed.

undefined
Requested Delivery Date

Requested delivery date.

2024-02-28T14:06:55.723Z
Sales Order ID

Sales order ID to update

38294
Settlement Discount Days

Settlement discount days.

30
Settlement Discount Percent

Settlement discount percent.

2.5
Site

The site ID. You can get and reference this value from the 'Get Site and Company Information' action.

9e12a1b-caa9-ca01-dcca-08dc12dd123a
Suppress Warnings

If this is set to true, we will suppress warnings specifically for payment with order and this is also the case if 'Is Editing' is false.

undefined
Use Invoice Address

True if this order uses the customer invoice address, else False.

undefined
Example Payload for Update Sales Order⤓
Loading…

Changelog​

2026-05-05​

Updated New and Updated Records trigger to use Sage 200's server-side OData $filter=date_time_updated gt <iso> query, replacing the previous full-fetch with client-side filtering

2026-04-30​

Updated spectral version

2026-03-16​

Improved input field documentation with formatted URL links for better readability

2026-03-05​

Added inline data sources for customer contacts, customer delivery addresses, products, sales orders, price bands, product groups, and tax codes to enhance data selection capabilities