Sage 200 - Accounts
A powerful API providing easy, secure, scalable integration into the core Sage 200 product which enables third-party developers to rapidly create apps and rich extensions. Accounts API exposes resources of Sage 200 related to accounting process such as customers, suppliers, ledger accounts, payment methods, journals, journal entries, analytics. Typical integrations use cases are financial reporting, expenses management, or invoice accounting.
Request URL
Request headers
string
Tenant unique identifier.
string
Company unique identifier.
string
Sage ID Access Token prefixed with the word 'Bearer'.
string
Subscription key which provides access to this API.
string
Media type of the body sent to the API.
(optional)
string
Media type of the body sent to the API.
Request body
List of the third parties, different of Customers and Suppliers
{
"id": "string",
"company_id": "string",
"application_id": "string",
"account_code": "string",
"account_id": "string",
"name": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string",
"notes": "string",
"identity_type": "1",
"identity": "string",
"tax_type": "1",
"payment_method_id": "string",
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"addresses": [
{
"id": "string",
"application_id": "string",
"type": "1",
"full_address": "string",
"type_street": "0",
"street": "string",
"number": "string",
"letter": "string",
"stair": "string",
"floor": "string",
"door": "string",
"country": "string",
"region": "string",
"post_code": "string",
"locality": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string"
}
],
"bank_accounts": [
{
"id": "string",
"application_id": "string",
"bank_id": "string",
"name": "string",
"iban": "string",
"addresses": [
{
"id": "string",
"application_id": "string",
"type": "1",
"full_address": "string",
"type_street": "0",
"street": "string",
"number": "string",
"letter": "string",
"stair": "string",
"floor": "string",
"door": "string",
"country": "string",
"region": "string",
"post_code": "string",
"locality": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string"
}
]
}
],
"timestamp": "string"
}
{
"type": "object",
"description": "List of the third parties, different of Customers and Suppliers. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Contacts",
"x-sage-relatedopeations": [
"companies",
"ledger_accounts",
"customers",
"payment_methods",
"zones",
"cost_centers",
"suppliers"
],
"required": [
"company_id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier for the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of the Third party",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application ID of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_code": {
"type": "string",
"description": "Account code of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_id": {
"type": "string",
"description": "Accountant ledger account associated",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "Name of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"email": {
"type": "string",
"description": "Email of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"telephone": {
"type": "string",
"description": "Telephone of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"mobile": {
"type": "string",
"description": "Mobile of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"fax": {
"type": "string",
"description": "Fax of the Third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"description": "Notes of theThird party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"identity_type": {
"type": "string",
"description": "Type of tax document of the Third party. See <a href=\"/docs#/spain/s200/accounts/v1/identitytype\">identitytype</a>",
"readOnly": false,
"x-sage-enumlink": "identitytype",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"identity": {
"type": "string",
"description": "VAT number / Tax ID Number of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"tax_type": {
"type": "string",
"description": "Tax reference of the Third party. See <a href=\"/docs#/spain/s200/accounts/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"description": "Payment Method ID of the Third party",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of valid extended properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"addresses": {
"type": "array",
"description": "List of Address of the Third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for the address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application id",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"type": {
"type": "string",
"description": "Type of address. See <a href=\"/docs#/spain/s200/accounts/v1/addresstype\">addresstype</a>",
"readOnly": false,
"x-sage-enumlink": "addresstype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"description": "Text with the full address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street address. See <a href=\"/docs#/spain/s200/accounts/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"description": "Street of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"description": "Letter of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"description": "Stair of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"description": "Floor of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"description": "Door of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country": {
"type": "string",
"description": "Country name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region": {
"type": "string",
"description": "Region name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"post_code": {
"type": "string",
"description": "Zip postal",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality": {
"type": "string",
"description": "Locality name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"email": {
"type": "string",
"description": "address email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"telephone": {
"type": "string",
"description": "address telephone",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"mobile": {
"type": "string",
"description": "address mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"fax": {
"type": "string",
"description": "address fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"bank_accounts": {
"type": "array",
"description": "List of Banks Accounts of the Third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application code",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_id": {
"type": "string",
"description": "Associated bank",
"x-sage-entitylink": "banks",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "Name of bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"iban": {
"type": "string",
"description": "IBAN of bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"addresses": {
"type": "array",
"description": "List of address of the bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for the address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application id",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"type": {
"type": "string",
"description": "Type of address. See <a href=\"/docs#/spain/s200/accounts/v1/addresstype\">addresstype</a>",
"readOnly": false,
"x-sage-enumlink": "addresstype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"description": "Text with the full address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street address. See <a href=\"/docs#/spain/s200/accounts/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"description": "Street of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"description": "Letter of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"description": "Stair of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"description": "Floor of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"description": "Door of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country": {
"type": "string",
"description": "Country name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region": {
"type": "string",
"description": "Region name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"post_code": {
"type": "string",
"description": "Zip postal",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality": {
"type": "string",
"description": "Locality name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"email": {
"type": "string",
"description": "address email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"telephone": {
"type": "string",
"description": "address telephone",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"mobile": {
"type": "string",
"description": "address mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"fax": {
"type": "string",
"description": "address fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the Other third Parties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
Response 201
OK. Resource created.
{
"id": "string",
"company_id": "string",
"application_id": "string",
"account_code": "string",
"account_id": "string",
"name": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string",
"notes": "string",
"identity_type": "1",
"identity": "string",
"tax_type": "1",
"payment_method_id": "string",
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"addresses": [
{
"id": "string",
"application_id": "string",
"type": "1",
"full_address": "string",
"type_street": "0",
"street": "string",
"number": "string",
"letter": "string",
"stair": "string",
"floor": "string",
"door": "string",
"country": "string",
"region": "string",
"post_code": "string",
"locality": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string"
}
],
"bank_accounts": [
{
"id": "string",
"application_id": "string",
"bank_id": "string",
"name": "string",
"iban": "string",
"addresses": [
{
"id": "string",
"application_id": "string",
"type": "1",
"full_address": "string",
"type_street": "0",
"street": "string",
"number": "string",
"letter": "string",
"stair": "string",
"floor": "string",
"door": "string",
"country": "string",
"region": "string",
"post_code": "string",
"locality": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string"
}
]
}
],
"timestamp": "string"
}
{
"type": "object",
"description": "List of the third parties, different of Customers and Suppliers. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Contacts",
"x-sage-relatedopeations": [
"companies",
"ledger_accounts",
"customers",
"payment_methods",
"zones",
"cost_centers",
"suppliers"
],
"required": [
"company_id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier for the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of the Third party",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application ID of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_code": {
"type": "string",
"description": "Account code of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_id": {
"type": "string",
"description": "Accountant ledger account associated",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "Name of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"email": {
"type": "string",
"description": "Email of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"telephone": {
"type": "string",
"description": "Telephone of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"mobile": {
"type": "string",
"description": "Mobile of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"fax": {
"type": "string",
"description": "Fax of the Third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"description": "Notes of theThird party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"identity_type": {
"type": "string",
"description": "Type of tax document of the Third party. See <a href=\"/docs#/spain/s200/accounts/v1/identitytype\">identitytype</a>",
"readOnly": false,
"x-sage-enumlink": "identitytype",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"identity": {
"type": "string",
"description": "VAT number / Tax ID Number of the Third party",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"tax_type": {
"type": "string",
"description": "Tax reference of the Third party. See <a href=\"/docs#/spain/s200/accounts/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"description": "Payment Method ID of the Third party",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of valid extended properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"addresses": {
"type": "array",
"description": "List of Address of the Third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for the address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application id",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"type": {
"type": "string",
"description": "Type of address. See <a href=\"/docs#/spain/s200/accounts/v1/addresstype\">addresstype</a>",
"readOnly": false,
"x-sage-enumlink": "addresstype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"description": "Text with the full address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street address. See <a href=\"/docs#/spain/s200/accounts/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"description": "Street of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"description": "Letter of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"description": "Stair of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"description": "Floor of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"description": "Door of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country": {
"type": "string",
"description": "Country name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region": {
"type": "string",
"description": "Region name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"post_code": {
"type": "string",
"description": "Zip postal",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality": {
"type": "string",
"description": "Locality name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"email": {
"type": "string",
"description": "address email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"telephone": {
"type": "string",
"description": "address telephone",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"mobile": {
"type": "string",
"description": "address mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"fax": {
"type": "string",
"description": "address fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"bank_accounts": {
"type": "array",
"description": "List of Banks Accounts of the Third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application code",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_id": {
"type": "string",
"description": "Associated bank",
"x-sage-entitylink": "banks",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "Name of bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"iban": {
"type": "string",
"description": "IBAN of bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"addresses": {
"type": "array",
"description": "List of address of the bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for the address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application id",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"type": {
"type": "string",
"description": "Type of address. See <a href=\"/docs#/spain/s200/accounts/v1/addresstype\">addresstype</a>",
"readOnly": false,
"x-sage-enumlink": "addresstype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"description": "Text with the full address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street address. See <a href=\"/docs#/spain/s200/accounts/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"description": "Street of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"description": "Letter of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"description": "Stair of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"description": "Floor of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"description": "Door of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country": {
"type": "string",
"description": "Country name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region": {
"type": "string",
"description": "Region name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"post_code": {
"type": "string",
"description": "Zip postal",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality": {
"type": "string",
"description": "Locality name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"email": {
"type": "string",
"description": "address email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"telephone": {
"type": "string",
"description": "address telephone",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"mobile": {
"type": "string",
"description": "address mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"fax": {
"type": "string",
"description": "address fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the Other third Parties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
Code samples
@ECHO OFF
curl -v -X POST "https://api.columbus.sage.com/es/s200/accounts/v1/other_third_parties"
-H "X-Site: "
-H "X-Company: "
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: "
-H "Content-Type: "
-H "Content-Type: application/json"
-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("X-Site", "");
client.DefaultRequestHeaders.Add("X-Company", "");
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://api.columbus.sage.com/es/s200/accounts/v1/other_third_parties?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // 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/es/s200/accounts/v1/other_third_parties");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("X-Site", "");
request.setHeader("X-Company", "");
request.setHeader("Authorization", "");
request.setHeader("Ocp-Apim-Subscription-Key", "");
request.setHeader("Content-Type", "");
request.setHeader("Content-Type", "application/json");
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/es/s200/accounts/v1/other_third_parties?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("X-Site","");
xhrObj.setRequestHeader("X-Company","");
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","");
xhrObj.setRequestHeader("Content-Type","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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/es/s200/accounts/v1/other_third_parties";
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:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"X-Site"];
[_request setValue:@"" forHTTPHeaderField:@"X-Company"];
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
[_request setValue:@"" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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/es/s200/accounts/v1/other_third_parties');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-Site' => '',
'X-Company' => '',
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '',
'Content-Type' => '',
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Content-Type': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("POST", "/es/s200/accounts/v1/other_third_parties?%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
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Content-Type': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("POST", "/es/s200/accounts/v1/other_third_parties?%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/es/s200/accounts/v1/other_third_parties')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['X-Site'] = ''
# Request headers
request['X-Company'] = ''
# Request headers
request['Authorization'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = ''
# Request headers
request['Content-Type'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# 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