Skip to main content

Sage 200 Connector

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

Connections

Sage 200 OAuth 2.0 Connection

Connect to Sage 200 using OAuth 2.0

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
ScopesA space-delimited set of one or more scopes to get the user's permission to access.openid profile email offline_access
Client ID
Client Secret
Ocp Apim Subscription KeyYou can get your subscription key following the steps at 'Obtain Developer Subscription Keys' here: https://developer.sage.com/200/api/get-started/
Sage 200 EditionThe Sage 200 Edition you are connecting to.

Actions

Create Customer

Create a new customer

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
ReferenceCustomer 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.
NameCustomer name.
Short NameCustomer short name.
On HoldTrue if customer account is on hold, else False.false
Status ReasonReason for change in account status.
Account Status TypeThe status of the customer account (Sage 200 Standard and versions of Professional released after July 2017). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/account_status_types
Currency IDCurrency record Id. This defaults to the base currency Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/currencies
Exchange Rate TypeThe type of exchange rate used on the customer account. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/exchange_rate_types
Telephone Country CodeTelephone country code.
Telephone Area CodeTelephone area code.
Telephone Subscriber NumberTelephone subscriber number.
Fax Country CodeFax country code.
Fax Area CodeFax area code.
Fax Subscriber NumberFax subscriber number.
WebsiteWebsite address.
Additional FieldsAdditional fields that are not covered by the standard inputs. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customers
Debug RequestEnabling this flag will log out the current request.false

Create Customer Delivery Address

Create a new customer delivery address

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer IdUnique Id of the customer account the customer delivery address is associated with.
DescriptionThe description of the customer delivery address.
Tax Code IdThe tax code record Id.
Is DefaultFlag to indicate if this is the default customer delivery address for the parent customer.false
Postal NamePostal name is the name of the person or company who the invoice or sales order is addressed to.
Address 1Address line 1.
Address 2Address line 2.
Address 3Address line 3.
Address 4Address line 4.
CityCity (if using segmented addresses in Sage 200 Professional).
CountyCounty (if using segmented addresses in Sage 200 Professional).
PostcodePostcode.
Address Country Code IdCountry code Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/country_codes
ContactThe contact associated with the customer delivery address.
TelephoneThe telephone number associated with the customer delivery address.
FaxThe fax number associated with the customer delivery address.
EmailThe email address associated with the customer delivery address.
Tax NumberThe tax number.
Country Code IdVAT details Country code Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/country_codes
Debug RequestEnabling this flag will log out the current request.false

Create Product

Create a new product

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Product CodeProduct code.
Product NameProduct name.
Product Group IDProduct group record Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/product_groups
Product DescriptionProduct description.
Use Description On DocumentsWhether to use the product description on order and invoice documents.false
Product BarcodeProduct bar code.
Allow Sales OrderIndicates whether the product is allowed on sales orders and invoicing.true
Tax Code IDTax code record Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/tax_codes
Product Status TypeThe product status type. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/product_status_types
Fulfilment Method TypeThe fulfilment method type of the product. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/fulfilment_method_types
Fulfilment Sequence TypeThe fulfilment sequence type of the product. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/fulfilment_sequence_types
Inactivation DateIf the product was made inactive, the date on which the product was made inactive.
ManufacturerThe product manufacturer.
Part NumberThe product part number.
Label Printing Option TypeThe label printing option type. (Sage 200 Professional only). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/label_printing_option_types
Traceable TypeThe traceable type of the product. (Sage 200 Professional only). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/traceable_types
Sale From Single BatchIndicates whether the product is sold from a single batch. (Sage 200 Professional only).false
Allow Duplicate NumbersIndicates whether the product allows duplicate numbers. (Sage 200 Professional only).false
Uses Alternative ReferenceIndicates whether the product uses alternative references. (Sage 200 Professional only).false
Uses Sell By DateIndicates whether the product uses sell by dates. (Sage 200 Professional only).false
Uses Use By DateIndicates whether the product uses use by dates. (Sage 200 Professional only).false
Shelf LifeThe shelf life of the product. (Sage 200 Professional only).
Shelf Life TypeThe shelf life type of the product. (Sage 200 Professional only). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/time_unit_types
Additional FieldsAdditional fields that are not covered by the standard inputs. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/products
Debug RequestEnabling this flag will log out the current request.false

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.

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer IDCustomer record ID to record a sale against. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customers
Transaction DateTransaction date. This defaults to the current system date.
Due DateDate the invoice is due to be paid.
Exchange RateExchange rate for the invoice. This defaults to the customer exchange rate.
ReferenceInvoice reference.
Second ReferenceInvoice second reference.
Settled ImmediatelyWhen set to True this indicates that the invoice has been paid and any settlement discount has been applied.false
Document Goods ValueValue of goods.
Document Tax ValueTax value.
Document Discount ValueDiscount value.
Document Tax Discount ValueAmount VAT is discounted when a settlement discount is applied.
Discount PercentPercentage discount. This defaults to the settlement discount from the customer record.
Discount DaysNumber of days to pay to qualify for the settlement discount. This defaults to the settlement days from the customer record.
Triangular TransactionIndicates whether the transaction is triangluted.false
Tax Analysis ItemsTax analysis lines. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/sales_invoices_tax_analysis_items
Nominal Analysis ItemsNominal analysis lines. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/sales_invoices_nominal_analysis_items
Debug RequestEnabling this flag will log out the current request.false

Create Sales Order

Create a new sales order

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer IDCustomer record ID to create the sales order for.
Document NumberSales 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.
Is EditingIf 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 LinesIf 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
Override On HoldAllows 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
Recalculate PricesAllows recalculation of the prices for the order when the exchange rate has changed.false
Apply Available Document Discount PercentThis 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
Customer Delivery Address IDThe Id of the customer delivery address to copy details to the sales order delivery address and resets 'Use Invoice Address'. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_delivery_addresses
Suppress WarningsIf 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
Customer TypeSOP customer type. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/sop_customer_types
Document DateSales order document date.
Exchange RateExchange rate.
Customer Document NumberCustomer document number.
Use Invoice AddressTrue if this order uses the customer invoice address, else False.false
Is TriangulatedWhether this order is triangulated and applies only to an EU customer with a different country code to that set in the company details.false
Settlement Discount DaysSettlement discount days.
Settlement Discount PercentSettlement discount percent.
Document Discount PercentDocument 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.
Document Created ByThe person who created the sales order.
Requested Delivery DateRequested delivery date.
Promised Delivery DatePromised delivery date.
Quotation Expiry DateQuotation expiry date (only used for quotations).
Order PriorityOrder priority.
Additional FieldsAdditional fields that are not covered by the standard inputs. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/sop_orders
Debug RequestEnabling this flag will log out the current request.false

Delete Customer

Delete a customer by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer IDThe ID of the customer to delete.
Debug RequestEnabling this flag will log out the current request.false

Delete Customer Contact

Delete a customer contact

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer Contact IDThe ID of the customer contact to delete
Debug RequestEnabling this flag will log out the current request.false

Delete Customer Delivery Address

Delete a customer delivery address by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Delivery Address IDThe ID of the customer delivery addresses to delete.
Debug RequestEnabling this flag will log out the current request.false

Delete Product

Delete a product by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Product IDThe ID of the product to delete.
Debug RequestEnabling this flag will log out the current request.false

Delete Sales Order

Delete an existing sales order by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Sales Order IDSales order ID to delete
Debug RequestEnabling this flag will log out the current request.false

Get Customer

Retrieve a customer by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer IDThe ID of the customer to retrieve.
Debug RequestEnabling this flag will log out the current request.false

Get Customer Contact

Retrieve a customer contact by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer Contact IDThe ID of the customer contact to retrieve
Debug RequestEnabling this flag will log out the current request.false

Get Customer Delivery Address

Retrieve customer delivery address by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Delivery Address IDThe ID of the customer delivery addresses to retrieve.
Debug RequestEnabling this flag will log out the current request.false

Get Customer Price Band

Retrieve a customer price band by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer Price Band IDThe ID of the customer price band to retrieve
Debug RequestEnabling this flag will log out the current request.false

Get Items on a Sales Order

Retrieve a list of items attached to a sales order

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Order Line IDThe Sales Order Line ID. This can be found in the Sales Order Line 'lines' array attribute.
Debug RequestEnabling this flag will log out the current request.false

Get Price Band

Retrieve a price band by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Price Band IDThe ID of the price band to retrieve
Debug RequestEnabling this flag will log out the current request.false

Get Product

Retrieve a product by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Product IDThe ID of the product to retrieve.
Debug RequestEnabling this flag will log out the current request.false

Get Product Group

Retrieve a product group by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Product Group IDThe ID of the product group to retrieve.
Debug RequestEnabling this flag will log out the current request.false

Get Product Price Views

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

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Debug RequestEnabling this flag will log out the current request.false

Get Sales Invoice, Return, and Credit Views

Retrieve a view of sales orders and returns and invoices and credit notes.

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Debug RequestEnabling this flag will log out the current request.false

Get Sales Order

Retrieve an existing sales order by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Sales Order IDSales order ID to retrieve
Debug RequestEnabling this flag will log out the current request.false

Get Site and Company Information

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

InputCommentsDefault
Connection
Debug RequestEnabling this flag will log out the current request.false

Get Tax Code

Retrieve a tax code by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Tax Code IDThe ID of the tax code to retrieve
Debug RequestEnabling this flag will log out the current request.false

List Customer Contacts

Retrieve a list of customer contacts

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Customer Delivery Addresses

Retrieve a list of customer delivery addresses

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Customer Price Bands

Retrieve a list of customer price bands

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Customers

Retrieve a list of all customers

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Price Bands

Retrieve a list of price bands

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Pricing Source Types

Retrieve a list of pricing source types

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Debug RequestEnabling this flag will log out the current request.false

List Pricing Types

Retrieve a list of pricing types

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Debug RequestEnabling this flag will log out the current request.false

List Product Groups

Retrieve a list of product groups

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Products

Retrieve a list of products

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Sales Order

Retrieve a list of sales orders

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

List Tax Codes

Retrieve a list of tax codes

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Filter Data After DateFilter data to only include items that have been updated after this date.
Debug RequestEnabling this flag will log out the current request.false

Raw Request

Send raw HTTP request to Sage 200

InputCommentsDefault
Connection
URLInput 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.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA 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.
HeaderA list of headers to send with the request. Subscription key and Authorization headers are already included.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf 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
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Search Customers

Search customer list

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Debug RequestEnabling this flag will log out the current request.false

Search Product Groups

Search the list of product groups

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Debug RequestEnabling this flag will log out the current request.false

Search Products

Search the list of products

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Debug RequestEnabling this flag will log out the current request.false

Update Customer

Edit an existing customer

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer IDThe ID of the customer to update.
Short NameCustomer short name.
On HoldTrue if customer account is on hold, else False.undefined
Status ReasonReason for change in account status.
Account Status TypeThe status of the customer account (Sage 200 Standard and versions of Professional released after July 2017). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/account_status_types
Currency IDCurrency record Id. This defaults to the base currency Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/currencies
Exchange Rate TypeThe type of exchange rate used on the customer account. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/exchange_rate_types
Telephone Country CodeTelephone country code.
Telephone Area CodeTelephone area code.
Telephone Subscriber NumberTelephone subscriber number.
Fax Country CodeFax country code.
Fax Area CodeFax area code.
Fax Subscriber NumberFax subscriber number.
WebsiteWebsite address.
Additional FieldsAdditional fields that are not covered by the standard inputs. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customers
Debug RequestEnabling this flag will log out the current request.false

Update Customer Contact

Edit an existing customer contact by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Customer IDThe ID of the customer contact to update
Salutation IDSalutation record Id.
First NameContact first name.
Middle NameContact middle name.
Last NameContact surname.
Is To DeleteWhen updating an existing customer, whether to delete this contact from the collection of customer contacts.undefined
EmailsAn array of customer emails. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_emails
TelephonesAn array of customer telephones. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_telephones
MobilesAn array of customer mobiles. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_mobiles
FaxesAn array of customer faxes. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_faxes
WebsitesAn array of customer websites. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_websites
RolesAn array of customer contact roles. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_contact_roles
Debug RequestEnabling this flag will log out the current request.false

Update Customer Delivery Address

Edit an existing customer delivery address by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Delivery Address IDThe ID of the customer delivery addresses to update.
Is DefaultFlag to indicate if this is the default customer delivery address for the parent customer.undefined
Postal NamePostal name is the name of the person or company who the invoice or sales order is addressed to.
Address 1Address line 1.
Address 2Address line 2.
Address 3Address line 3.
Address 4Address line 4.
CityCity (if using segmented addresses in Sage 200 Professional).
CountyCounty (if using segmented addresses in Sage 200 Professional).
PostcodePostcode.
Address Country Code IdCountry code Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/country_codes
ContactThe contact associated with the customer delivery address.
TelephoneThe telephone number associated with the customer delivery address.
FaxThe fax number associated with the customer delivery address.
EmailThe email address associated with the customer delivery address.
Tax NumberThe tax number.
Country Code IdVAT details Country code Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/country_codes
Debug RequestEnabling this flag will log out the current request.false

Update Product

Edit an existing product by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Product IDThe ID of the product to update.
Product DescriptionProduct description.
Use Description On DocumentsWhether to use the product description on order and invoice documents.undefined
Product BarcodeProduct bar code.
Allow Sales OrderIndicates whether the product is allowed on sales orders and invoicing.undefined
Tax Code IDTax code record Id. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/tax_codes
Product Status TypeThe product status type. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/product_status_types
Fulfilment Method TypeThe fulfilment method type of the product. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/fulfilment_method_types
Fulfilment Sequence TypeThe fulfilment sequence type of the product. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/fulfilment_sequence_types
Inactivation DateIf the product was made inactive, the date on which the product was made inactive.
ManufacturerThe product manufacturer.
Part NumberThe product part number.
Label Printing Option TypeThe label printing option type. (Sage 200 Professional only). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/label_printing_option_types
Traceable TypeThe traceable type of the product. (Sage 200 Professional only). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/traceable_types
Sale From Single BatchIndicates whether the product is sold from a single batch. (Sage 200 Professional only).undefined
Allow Duplicate NumbersIndicates whether the product allows duplicate numbers. (Sage 200 Professional only).undefined
Uses Alternative ReferenceIndicates whether the product uses alternative references. (Sage 200 Professional only).undefined
Uses Sell By DateIndicates whether the product uses sell by dates. (Sage 200 Professional only).undefined
Uses Use By DateIndicates whether the product uses use by dates. (Sage 200 Professional only).undefined
Shelf LifeThe shelf life of the product. (Sage 200 Professional only).
Shelf Life TypeThe shelf life type of the product. (Sage 200 Professional only). See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/time_unit_types
Additional FieldsAdditional fields that are not covered by the standard inputs. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/products
Debug RequestEnabling this flag will log out the current request.false

Update Sales Order

Edit an existing sales Order by ID

InputCommentsDefault
Connection
SiteThe site ID. You can get and reference this value from the 'Get Site and Company Information' action.
CompanyThe company ID. You can get and reference this value from the 'Get Site and Company Information' action.
Sales Order IDSales order ID to update
Is EditingIf 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 LinesIf 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
Override On HoldAllows 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
Recalculate PricesAllows recalculation of the prices for the order when the exchange rate has changed.undefined
Apply Available Document Discount PercentThis 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
Customer Delivery Address IDThe Id of the customer delivery address to copy details to the sales order delivery address and resets 'Use Invoice Address'. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/customer_delivery_addresses
Suppress WarningsIf 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
Customer TypeSOP customer type. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/sop_customer_types
Document DateSales order document date.
Exchange RateExchange rate.
Customer Document NumberCustomer document number.
Use Invoice AddressTrue if this order uses the customer invoice address, else False.undefined
Is TriangulatedWhether this order is triangulated and applies only to an EU customer with a different country code to that set in the company details.undefined
Settlement Discount DaysSettlement discount days.
Settlement Discount PercentSettlement discount percent.
Document Discount PercentDocument 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.
Document Created ByThe person who created the sales order.
Requested Delivery DateRequested delivery date.
Promised Delivery DatePromised delivery date.
Quotation Expiry DateQuotation expiry date (only used for quotations).
Order PriorityOrder priority.
Additional FieldsAdditional fields that are not covered by the standard inputs. See https://developer.columbus.sage.com/docs#/uk/sage200extra/accounts/v1/sop_orders
Debug RequestEnabling this flag will log out the current request.false