Sage 200 Extra v1
Request URL
Request parameters
number
Request headers
Request body
Response 200
{
"id": 0,
"reference": "string",
"name": "string",
"short_name": "string",
"balance": 0.0,
"on_hold": true,
"status_reason": "string",
"account_status_type": "string",
"currency_id": 0,
"exchange_rate_type": "string",
"telephone_country_code": "string",
"telephone_area_code": "string",
"telephone_subscriber_number": "string",
"fax_country_code": "string",
"fax_area_code": "string",
"fax_subscriber_number": "string",
"website": "string",
"credit_limit": 0.0,
"country_code_id": 0,
"default_tax_code_id": 0,
"vat_number": "string",
"duns_code": "string",
"account_type": "string",
"early_settlement_discount_percent": 0.0,
"early_settlement_discount_days": 0,
"payment_terms_days": 0,
"payment_terms_basis": "string",
"average_time_to_pay": 0,
"terms_agreed": true,
"value_of_current_orders_in_sop": 0.0,
"credit_bureau_id": 0,
"credit_position_id": 0,
"finance_charge_id": 0,
"trading_terms": "string",
"credit_reference": "string",
"account_opened": "string",
"last_credit_review": "string",
"next_credit_review": "string",
"application_date": "string",
"date_received": "string",
"date_finance_charge_last_run": "string",
"office_type": "string",
"associated_head_office_id": 0,
"produce_statements_for_customer": true,
"is_head_office_with_branches": true,
"use_consolidated_billing": true,
"order_priority": "string",
"use_tax_code_as_default": true,
"months_to_keep_transactions": 0,
"default_nominal_code_id": 0,
"default_nominal_code_reference": "string",
"default_nominal_code_cost_centre": "string",
"default_nominal_code_department": "string",
"invoice_discount_percent": 0.0,
"invoice_line_discount_percent": 0.0,
"customer_discount_group_id": 0,
"order_value_discount_id": 0,
"price_band_id": 0,
"analysis_code_1": "string",
"analysis_code_2": "string",
"analysis_code_3": "string",
"analysis_code_4": "string",
"analysis_code_5": "string",
"analysis_code_6": "string",
"analysis_code_7": "string",
"analysis_code_8": "string",
"analysis_code_9": "string",
"analysis_code_10": "string",
"analysis_code_11": "string",
"analysis_code_12": "string",
"analysis_code_13": "string",
"analysis_code_14": "string",
"analysis_code_15": "string",
"analysis_code_16": "string",
"analysis_code_17": "string",
"analysis_code_18": "string",
"analysis_code_19": "string",
"analysis_code_20": "string",
"spare_text_1": "string",
"spare_text_2": "string",
"spare_text_3": "string",
"spare_text_4": "string",
"spare_text_5": "string",
"spare_text_6": "string",
"spare_text_7": "string",
"spare_text_8": "string",
"spare_text_9": "string",
"spare_text_10": "string",
"spare_number_1": 0.0,
"spare_number_2": 0.0,
"spare_number_3": 0.0,
"spare_number_4": 0.0,
"spare_number_5": 0.0,
"spare_number_6": 0.0,
"spare_number_7": 0.0,
"spare_number_8": 0.0,
"spare_number_9": 0.0,
"spare_number_10": 0.0,
"spare_date_1": "string",
"spare_date_2": "string",
"spare_date_3": "string",
"spare_date_4": "string",
"spare_date_5": "string",
"spare_bool_1": true,
"spare_bool_2": true,
"spare_bool_3": true,
"spare_bool_4": true,
"spare_bool_5": true,
"associated_head_office": {},
"country_code": {},
"credit_bureau": {},
"credit_memo_note": {
"id": 0,
"note": "string",
"created_by": "string",
"date_time_created": "string",
"date_time_updated": "string"
},
"credit_position": {},
"currency": {},
"customer_discount_group": {},
"default_nominal_code": {},
"default_tax_code": {},
"finance_charge": {},
"main_address": {
"id": 0,
"customer_id": 0,
"address_1": "string",
"address_2": "string",
"address_3": "string",
"address_4": "string",
"city": "string",
"county": "string",
"postcode": "string",
"country": "string",
"contact_name": "string",
"address_country_code_id": 0,
"address_country_code": {},
"date_time_created": "string",
"date_time_updated": "string"
},
"order_value_discount": {},
"price_band": {},
"sales_credit_note_layout": {},
"sales_invoice_layout": {},
"statement_layout": {},
"status": {
"is_live": true,
"date_time_created": "string",
"date_time_updated": "string"
},
"alerts": [
{
"id": 0,
"customer_id": 0,
"alert_text": "string",
"is_active": true,
"show_alert_for_orders": true,
"show_alert_for_proformas": true,
"show_alert_for_quotes": true,
"show_alert_for_credit_notes": true,
"show_alert_for_price_enquiries": true,
"show_alert_for_invoices": true,
"show_alert_for_returns": true,
"show_alert_for_project_bills": true,
"is_to_delete": true,
"updated_by": "string",
"date_time_created": "string",
"date_time_updated": "string"
}
],
"cards": [
{
"id": 0,
"customer_id": 0,
"last_used_date": "string",
"is_to_delete": true
}
],
"contacts": [
{
"id": 0,
"customer_id": 0,
"salutation_id": 0,
"name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"default_telephone": "string",
"default_email": "string",
"is_default": true,
"is_to_delete": true,
"salutation": {},
"emails": [
{
"id": 0,
"email": "string",
"customer_contact_id": 0,
"is_default": true,
"is_to_delete": true,
"customer_contact": {},
"date_time_created": "string",
"date_time_updated": "string"
}
],
"telephones": [
{
"id": 0,
"full_number": "string",
"country_code": "string",
"area_code": "string",
"subscriber_number": "string",
"customer_contact_id": 0,
"is_default": true,
"is_to_delete": true,
"customer_contact": {},
"date_time_created": "string",
"date_time_updated": "string"
}
],
"mobiles": [
{
"id": 0,
"full_number": "string",
"country_code": "string",
"area_code": "string",
"subscriber_number": "string",
"customer_contact_id": 0,
"is_default": true,
"is_to_delete": true,
"customer_contact": {},
"date_time_created": "string",
"date_time_updated": "string"
}
],
"faxes": [
{
"id": 0,
"full_number": "string",
"country_code": "string",
"area_code": "string",
"subscriber_number": "string",
"customer_contact_id": 0,
"is_default": true,
"is_to_delete": true,
"customer_contact": {},
"date_time_created": "string",
"date_time_updated": "string"
}
],
"websites": [
{
"id": 0,
"website": "string",
"customer_contact_id": 0,
"is_default": true,
"is_to_delete": true,
"customer_contact": {},
"date_time_created": "string",
"date_time_updated": "string"
}
],
"roles": [
{
"id": 0,
"customer_contact_id": 0,
"trader_contact_role_id": 0,
"is_preferred_contact_for_role": true,
"is_to_delete": true,
"date_time_created": "string",
"date_time_updated": "string"
}
],
"date_time_created": "string",
"date_time_updated": "string"
}
],
"limited_price_bands": [
{
"id": 0,
"customer_id": 0,
"price_band_id": 0,
"is_to_delete": true,
"price_band": {},
"date_time_created": "string",
"date_time_updated": "string"
}
],
"memos": [
{
"id": 0,
"customer_id": 0,
"note": "string",
"is_active": true,
"is_to_delete": true,
"created_by": "string",
"date_time_created": "string",
"date_time_updated": "string"
}
],
"date_time_created": "string",
"date_time_updated": "string"
}{
"type": "object",
"required": [
"reference",
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"reference": {
"type": "string",
"maxLength": 8
},
"name": {
"type": "string",
"maxLength": 60
},
"short_name": {
"type": "string",
"maxLength": 8
},
"balance": {
"type": "number",
"format": "decimal 2dp",
"readOnly": true
},
"on_hold": {
"type": "boolean"
},
"status_reason": {
"type": "string",
"maxLength": 256
},
"account_status_type": {
"type": "string",
"maxLength": 20
},
"currency_id": {
"type": "integer",
"format": "int64"
},
"exchange_rate_type": {
"type": "string",
"maxLength": 20
},
"telephone_country_code": {
"type": "string",
"maxLength": 5
},
"telephone_area_code": {
"type": "string",
"maxLength": 20
},
"telephone_subscriber_number": {
"type": "string",
"maxLength": 200
},
"fax_country_code": {
"type": "string",
"maxLength": 5
},
"fax_area_code": {
"type": "string",
"maxLength": 20
},
"fax_subscriber_number": {
"type": "string",
"maxLength": 200
},
"website": {
"type": "string",
"maxLength": 200
},
"credit_limit": {
"type": "number",
"format": "decimal 2dp"
},
"country_code_id": {
"type": "integer",
"format": "int64"
},
"default_tax_code_id": {
"type": "integer",
"format": "int64"
},
"vat_number": {
"type": "string",
"maxLength": 30
},
"duns_code": {
"type": "string",
"maxLength": 9
},
"account_type": {
"type": "string",
"maxLength": 20
},
"early_settlement_discount_percent": {
"type": "number",
"format": "decimal 2dp"
},
"early_settlement_discount_days": {
"type": "integer",
"format": "int16"
},
"payment_terms_days": {
"type": "integer",
"format": "int16"
},
"payment_terms_basis": {
"type": "string",
"maxLength": 20
},
"average_time_to_pay": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"terms_agreed": {
"type": "boolean"
},
"value_of_current_orders_in_sop": {
"type": "number",
"format": "decimal 2dp",
"readOnly": true
},
"credit_bureau_id": {
"type": "integer",
"format": "int64"
},
"credit_position_id": {
"type": "integer",
"format": "int64"
},
"finance_charge_id": {
"type": "integer",
"format": "int64"
},
"trading_terms": {
"type": "string",
"maxLength": 30
},
"credit_reference": {
"type": "string",
"maxLength": 60
},
"account_opened": {
"type": "string",
"format": "date-time"
},
"last_credit_review": {
"type": "string",
"format": "date-time"
},
"next_credit_review": {
"type": "string",
"format": "date-time"
},
"application_date": {
"type": "string",
"format": "date-time"
},
"date_received": {
"type": "string",
"format": "date-time"
},
"date_finance_charge_last_run": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"office_type": {
"type": "string",
"maxLength": 20
},
"associated_head_office_id": {
"type": "integer",
"format": "int64"
},
"produce_statements_for_customer": {
"type": "boolean"
},
"is_head_office_with_branches": {
"type": "boolean"
},
"use_consolidated_billing": {
"type": "boolean"
},
"order_priority": {
"type": "string",
"maxLength": 1
},
"use_tax_code_as_default": {
"type": "boolean"
},
"months_to_keep_transactions": {
"type": "integer",
"format": "int16"
},
"default_nominal_code_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"default_nominal_code_reference": {
"type": "string",
"maxLength": 8
},
"default_nominal_code_cost_centre": {
"type": "string",
"maxLength": 3
},
"default_nominal_code_department": {
"type": "string",
"maxLength": 3
},
"invoice_discount_percent": {
"type": "number",
"format": "decimal 2dp"
},
"invoice_line_discount_percent": {
"type": "number",
"format": "decimal 2dp"
},
"customer_discount_group_id": {
"type": "integer",
"format": "int64"
},
"order_value_discount_id": {
"type": "integer",
"format": "int64"
},
"price_band_id": {
"type": "integer",
"format": "int64"
},
"analysis_code_1": {
"type": "string",
"maxLength": 60
},
"analysis_code_2": {
"type": "string",
"maxLength": 60
},
"analysis_code_3": {
"type": "string",
"maxLength": 60
},
"analysis_code_4": {
"type": "string",
"maxLength": 60
},
"analysis_code_5": {
"type": "string",
"maxLength": 60
},
"analysis_code_6": {
"type": "string",
"maxLength": 60
},
"analysis_code_7": {
"type": "string",
"maxLength": 60
},
"analysis_code_8": {
"type": "string",
"maxLength": 60
},
"analysis_code_9": {
"type": "string",
"maxLength": 60
},
"analysis_code_10": {
"type": "string",
"maxLength": 60
},
"analysis_code_11": {
"type": "string",
"maxLength": 60
},
"analysis_code_12": {
"type": "string",
"maxLength": 60
},
"analysis_code_13": {
"type": "string",
"maxLength": 60
},
"analysis_code_14": {
"type": "string",
"maxLength": 60
},
"analysis_code_15": {
"type": "string",
"maxLength": 60
},
"analysis_code_16": {
"type": "string",
"maxLength": 60
},
"analysis_code_17": {
"type": "string",
"maxLength": 60
},
"analysis_code_18": {
"type": "string",
"maxLength": 60
},
"analysis_code_19": {
"type": "string",
"maxLength": 60
},
"analysis_code_20": {
"type": "string",
"maxLength": 60
},
"spare_text_1": {
"type": "string",
"maxLength": 100
},
"spare_text_2": {
"type": "string",
"maxLength": 100
},
"spare_text_3": {
"type": "string",
"maxLength": 100
},
"spare_text_4": {
"type": "string",
"maxLength": 100
},
"spare_text_5": {
"type": "string",
"maxLength": 100
},
"spare_text_6": {
"type": "string",
"maxLength": 100
},
"spare_text_7": {
"type": "string",
"maxLength": 100
},
"spare_text_8": {
"type": "string",
"maxLength": 100
},
"spare_text_9": {
"type": "string",
"maxLength": 100
},
"spare_text_10": {
"type": "string",
"maxLength": 100
},
"spare_number_1": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_2": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_3": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_4": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_5": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_6": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_7": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_8": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_9": {
"type": "number",
"format": "decimal 5dp"
},
"spare_number_10": {
"type": "number",
"format": "decimal 5dp"
},
"spare_date_1": {
"type": "string",
"format": "date-time"
},
"spare_date_2": {
"type": "string",
"format": "date-time"
},
"spare_date_3": {
"type": "string",
"format": "date-time"
},
"spare_date_4": {
"type": "string",
"format": "date-time"
},
"spare_date_5": {
"type": "string",
"format": "date-time"
},
"spare_bool_1": {
"type": "boolean"
},
"spare_bool_2": {
"type": "boolean"
},
"spare_bool_3": {
"type": "boolean"
},
"spare_bool_4": {
"type": "boolean"
},
"spare_bool_5": {
"type": "boolean"
},
"associated_head_office": {
"type": "object",
"readOnly": true
},
"country_code": {
"type": "object",
"readOnly": true
},
"credit_bureau": {
"type": "object",
"readOnly": true
},
"credit_memo_note": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"note": {
"type": "string",
"maxLength": 1000
},
"created_by": {
"type": "string",
"maxLength": 50,
"readOnly": true
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"credit_position": {
"type": "object",
"readOnly": true
},
"currency": {
"type": "object",
"readOnly": true
},
"customer_discount_group": {
"type": "object",
"readOnly": true
},
"default_nominal_code": {
"type": "object",
"readOnly": true
},
"default_tax_code": {
"type": "object",
"readOnly": true
},
"finance_charge": {
"type": "object",
"readOnly": true
},
"main_address": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"customer_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"address_1": {
"type": "string",
"maxLength": 60
},
"address_2": {
"type": "string",
"maxLength": 60
},
"address_3": {
"type": "string",
"maxLength": 60
},
"address_4": {
"type": "string",
"maxLength": 60
},
"city": {
"type": "string",
"maxLength": 60
},
"county": {
"type": "string",
"maxLength": 60
},
"postcode": {
"type": "string",
"maxLength": 10
},
"country": {
"type": "string",
"maxLength": 60,
"readOnly": true
},
"contact_name": {
"type": "string",
"maxLength": 235,
"readOnly": true
},
"address_country_code_id": {
"type": "integer",
"format": "int64"
},
"address_country_code": {
"type": "object",
"readOnly": true
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"order_value_discount": {
"type": "object",
"readOnly": true
},
"price_band": {
"type": "object",
"readOnly": true
},
"sales_credit_note_layout": {
"type": "object",
"readOnly": true
},
"sales_invoice_layout": {
"type": "object",
"readOnly": true
},
"statement_layout": {
"type": "object",
"readOnly": true
},
"status": {
"type": "object",
"readOnly": true,
"properties": {
"is_live": {
"type": "boolean",
"readOnly": true
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"alerts": {
"type": "array",
"items": {
"type": "object",
"required": [
"customer_id"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"customer_id": {
"type": "integer",
"format": "int64"
},
"alert_text": {
"type": "string",
"maxLength": 255
},
"is_active": {
"type": "boolean"
},
"show_alert_for_orders": {
"type": "boolean"
},
"show_alert_for_proformas": {
"type": "boolean"
},
"show_alert_for_quotes": {
"type": "boolean"
},
"show_alert_for_credit_notes": {
"type": "boolean"
},
"show_alert_for_price_enquiries": {
"type": "boolean"
},
"show_alert_for_invoices": {
"type": "boolean"
},
"show_alert_for_returns": {
"type": "boolean"
},
"show_alert_for_project_bills": {
"type": "boolean"
},
"is_to_delete": {
"type": "boolean"
},
"updated_by": {
"type": "string",
"maxLength": 30,
"readOnly": true
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"cards": {
"type": "array",
"items": {
"type": "object",
"required": [
"customer_id",
"description"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"customer_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"last_used_date": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"is_to_delete": {
"type": "boolean"
}
}
}
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"customer_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"salutation_id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string",
"maxLength": 180,
"readOnly": true
},
"first_name": {
"type": "string",
"maxLength": 60
},
"middle_name": {
"type": "string",
"maxLength": 60
},
"last_name": {
"type": "string",
"maxLength": 60
},
"default_telephone": {
"type": "string",
"maxLength": 227,
"readOnly": true
},
"default_email": {
"type": "string",
"maxLength": 227,
"readOnly": true
},
"is_default": {
"type": "boolean",
"readOnly": true
},
"is_to_delete": {
"type": "boolean"
},
"salutation": {
"type": "object",
"readOnly": true
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"email": {
"type": "string",
"maxLength": 227
},
"customer_contact_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"is_default": {
"type": "boolean"
},
"is_to_delete": {
"type": "boolean"
},
"customer_contact": {
"type": "object"
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"telephones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"full_number": {
"type": "string",
"maxLength": 227,
"readOnly": true
},
"country_code": {
"type": "string",
"maxLength": 5
},
"area_code": {
"type": "string",
"maxLength": 20
},
"subscriber_number": {
"type": "string",
"maxLength": 200
},
"customer_contact_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"is_default": {
"type": "boolean"
},
"is_to_delete": {
"type": "boolean"
},
"customer_contact": {
"type": "object"
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"mobiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"full_number": {
"type": "string",
"maxLength": 227,
"readOnly": true
},
"country_code": {
"type": "string",
"maxLength": 5
},
"area_code": {
"type": "string",
"maxLength": 20
},
"subscriber_number": {
"type": "string",
"maxLength": 200
},
"customer_contact_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"is_default": {
"type": "boolean"
},
"is_to_delete": {
"type": "boolean"
},
"customer_contact": {
"type": "object"
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"faxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"full_number": {
"type": "string",
"maxLength": 227,
"readOnly": true
},
"country_code": {
"type": "string",
"maxLength": 5
},
"area_code": {
"type": "string",
"maxLength": 20
},
"subscriber_number": {
"type": "string",
"maxLength": 200
},
"customer_contact_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"is_default": {
"type": "boolean"
},
"is_to_delete": {
"type": "boolean"
},
"customer_contact": {
"type": "object"
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"websites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"website": {
"type": "string",
"maxLength": 227
},
"customer_contact_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"is_default": {
"type": "boolean"
},
"is_to_delete": {
"type": "boolean"
},
"customer_contact": {
"type": "object"
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"customer_contact_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"trader_contact_role_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"is_preferred_contact_for_role": {
"type": "boolean",
"readOnly": true
},
"is_to_delete": {
"type": "boolean"
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"limited_price_bands": {
"type": "array",
"readOnly": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"customer_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"price_band_id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"is_to_delete": {
"type": "boolean"
},
"price_band": {
"type": "object",
"readOnly": true
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"memos": {
"type": "array",
"items": {
"type": "object",
"required": [
"customer_id",
"note"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"customer_id": {
"type": "integer",
"format": "int64"
},
"note": {
"type": "string",
"maxLength": 1000
},
"is_active": {
"type": "boolean"
},
"is_to_delete": {
"type": "boolean"
},
"created_by": {
"type": "string",
"maxLength": 20,
"readOnly": true
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"date_time_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_time_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}Response 400
Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customers/{Id}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customers/{Id}?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customers/{Id}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customers/{Id}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customers/{Id}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customers/{Id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/uk/sage200extra/accounts/v1/customers/{Id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/uk/sage200extra/accounts/v1/customers/{Id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.columbus.sage.com/uk/sage200extra/accounts/v1/customers/{Id}')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body