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 parameters
string
JournalEntry unique identifier
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 Journal entries of the company
{
"id": "string",
"company_id": "string",
"journal_id": "string",
"application_id": "string",
"date": "string",
"journal_lines": [
{
"id": "string",
"account_id": "string",
"account_opposite_id": "string",
"description": "string",
"accounting_sign": "1",
"amount": 0.0,
"reference": "string",
"quantity": 0.0,
"reconcilation_code": "string",
"journal_third_party": {
"customer_id": "string",
"supplier_id": "string",
"other_third_party_id": "string"
},
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"journal_documents": [
{
"id": "string",
"period": "string",
"serial": "string",
"number": "string",
"issue_date": "string",
"document_type": "3",
"due_date": "string",
"identity_type": "1",
"identity": "string",
"name": "string",
"external_reference": "string",
"amount": 0.0,
"operation_code": "0",
"operation_date": "string",
"income_tax_base": 0.0,
"income_tax_id": "string",
"income_tax_rate": 0.0,
"income_tax_amount": 0.0,
"income_tax_type": "0",
"number_initial_document": "string",
"number_final_document": "string",
"total_number_document": 0,
"vat_type_system": "0"
}
],
"journal_taxes": [
{
"id": "string",
"vat_tax_rate_id": "string",
"base": 0.0,
"vat_tax_rate": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_rate": 0.0,
"surcharge_tax_amount": 0.0,
"total_tax_amount": 0.0,
"transaction_code": "1"
}
],
"journal_payments": [
{
"id": "string",
"document_id": "string",
"period": "string",
"serial": "string",
"number": 0,
"amount": 0.0,
"bank_account": {
"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"
}
]
},
"type": "1",
"payment_method_id": "string",
"bank_statement": "string",
"code_means_charge": "1",
"means_charge": "string"
}
],
"journal_analytics": [
{
"id": "string",
"cost_centers": [
"string"
],
"amount": 0.0,
"percentage": 0.0,
"quantity": 0.0,
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"journal_currency": {
"currency_id": "string",
"currency_amount": 0.0,
"currency_rate": 0.0
},
"journal_buildings": [
{
"id": "string",
"catastral_reference": "string",
"building_status": "string",
"base": 0.0,
"vat_tax_rate": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_rate": 0.0,
"surcharge_tax_amount": 0.0,
"income_tax_base": 0.0,
"income_tax_rate": 0.0,
"income_tax_amount": 0.0,
"income_tax_type": "0"
}
]
}
],
"timestamp": "string",
"journal_entry_type": "3",
"notes": "string"
}{
"type": "object",
"description": "List of Journal entries of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Journal",
"x-sage-relatedopeations": [
"companies",
"journals"
],
"required": [
"company_id",
"date"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier Journal entry",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"company_id": {
"type": "string",
"description": "Company ID of the Journal entry",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"journal_id": {
"type": "string",
"description": "Type of journal",
"x-sage-entitylink": "journals",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"application_id": {
"type": "string",
"description": "Application ID of the Journal entry",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of Jounal entry",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"journal_lines": {
"type": "array",
"description": "Journal lines details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier Journal line of accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"account_id": {
"type": "string",
"description": "Account ID of Journal Line",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_opposite_id": {
"type": "string",
"description": "Account opposite ID of Journal Line",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"description": {
"type": "string",
"description": "Description of the Journal Line",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"accounting_sign": {
"type": "string",
"description": "Sign of the Journal Line. See <a href=\"/docs#/spain/s200/accounts/v1/accountingsigntype\">accountingsigntype</a>",
"readOnly": false,
"x-sage-enumlink": "accountingsigntype",
"enum": [
"1",
"2"
],
"x-sage-queryable": true,
"x-sage-orderable": true
},
"amount": {
"type": "number",
"description": "Amount of Journal Line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"reference": {
"type": "string",
"description": "Reference of the line",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"quantity": {
"type": "number",
"description": "Quantity associated to the line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"reconcilation_code": {
"type": "string",
"description": "Reconciliation code number",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"journal_third_party": {
"type": "object",
"description": "Associated third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"customer_id": {
"type": "string",
"description": "Associated customer",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"supplier_id": {
"type": "string",
"description": "Associated supplier",
"x-sage-entitylink": "suppliers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"other_third_party_id": {
"type": "string",
"description": "Other third parties",
"x-sage-entitylink": "other_third_parties",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
}
}
},
"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
}
}
}
},
"journal_documents": {
"type": "array",
"description": "List of valid journal invoices associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID Invoice of accounts invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"period": {
"type": "string",
"description": "Period of the document (fiscal year)",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"serial": {
"type": "string",
"description": "Serial of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"issue_date": {
"type": "string",
"format": "date-time",
"description": "Date of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"document_type": {
"type": "string",
"description": "Type of accounts document. See <a href=\"/docs#/spain/s200/accounts/v1/documenttype\">documenttype</a>",
"readOnly": false,
"x-sage-enumlink": "documenttype",
"enum": [
"3",
"1",
"2"
],
"x-sage-queryable": true,
"x-sage-orderable": false
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Due date of the document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"identity_type": {
"type": "string",
"description": "Type of tax document of accounts document. 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 accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "description of the operation",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"external_reference": {
"type": "string",
"description": "External reference of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"amount": {
"type": "number",
"description": "Amount of accounts document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"operation_code": {
"type": "string",
"description": "Operation code of accounts document. See <a href=\"/docs#/spain/s200/accounts/v1/codeoperationtype\">codeoperationtype</a>",
"readOnly": false,
"x-sage-enumlink": "codeoperationtype",
"enum": [
"0",
"A",
"B",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"C"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"operation_date": {
"type": "string",
"format": "date-time",
"description": "Date of operation of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"income_tax_base": {
"type": "number",
"description": "Base for the income tax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_id": {
"type": "string",
"description": "Income tax id",
"x-sage-entitylink": "income_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate": {
"type": "number",
"description": "Percent INCOME_TAX of sales document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_amount": {
"type": "number",
"description": "Tax INCOME_TAX of sales document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_type": {
"type": "string",
"description": "Legal income tax type. See <a href=\"/docs#/spain/s200/accounts/v1/incometaxtype\">incometaxtype</a>",
"readOnly": false,
"x-sage-enumlink": "incometaxtype",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number_initial_document": {
"type": "string",
"description": "Number initial document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number_final_document": {
"type": "string",
"description": "Number Final Document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total_number_document": {
"type": "integer",
"format": "int32",
"description": "Total Number documents",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_type_system": {
"type": "string",
"description": "Type VAT system. See <a href=\"/docs#/spain/s200/accounts/v1/vattypecaja\">vattypecaja</a>",
"readOnly": false,
"x-sage-enumlink": "vattypecaja",
"enum": [
"0",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"journal_taxes": {
"type": "array",
"description": "List of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID Invoice Taxes of accounts",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate_id": {
"type": "string",
"description": "Tax rate id",
"x-sage-entitylink": "vat_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"base": {
"type": "number",
"description": "Taxable base of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate": {
"type": "number",
"description": "Tax VAT of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax Amount VAT of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax VAT_surcharge of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total_tax_amount": {
"type": "number",
"description": "Total taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"transaction_code": {
"type": "string",
"description": "invoice transaction code. See <a href=\"/docs#/spain/s200/accounts/v1/codetransactiontype\">codetransactiontype</a>",
"readOnly": false,
"x-sage-enumlink": "codetransactiontype",
"enum": [
"1",
"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",
"31",
"32",
"33",
"35",
"36",
"37",
"38",
"39",
"40",
"42",
"47",
"49",
"51",
"53",
"54",
"55",
"56",
"57",
"58",
"59",
"60",
"61"
],
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"journal_payments": {
"type": "array",
"description": "List of valid journal payments associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of payments",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"document_id": {
"type": "string",
"description": "Id Invoice of accounts payments",
"x-sage-entitylink": "journal_documents",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"period": {
"type": "string",
"description": "invoice payed period",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"serial": {
"type": "string",
"description": "invoice payed serial",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"number": {
"type": "integer",
"format": "int64",
"description": "invoice payed number",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"amount": {
"type": "number",
"description": "Amount of accounts payments",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_account": {
"type": "object",
"description": "Bank account of accounts payments",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"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
}
}
}
}
}
},
"type": {
"type": "string",
"description": "type of accounts payments. See <a href=\"/docs#/spain/s200/accounts/v1/paymenttype\">paymenttype</a>",
"readOnly": false,
"x-sage-enumlink": "paymenttype",
"enum": [
"1",
"2"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"description": "Id of the payment method",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_statement": {
"type": "string",
"description": "Bank statement for conciliating",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"code_means_charge": {
"type": "string",
"description": "Codigo Medio Cobro. See <a href=\"/docs#/spain/s200/accounts/v1/codemeanscharge\">codemeanscharge</a>",
"readOnly": false,
"x-sage-enumlink": "codemeanscharge",
"enum": [
"1",
"2",
"3"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"means_charge": {
"type": "string",
"description": "Medio cobro",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"journal_analytics": {
"type": "array",
"description": "List of analytical information",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the analytics",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"cost_centers": {
"type": "array",
"description": "Cost centers associated",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"amount": {
"type": "number",
"description": "Amount associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"percentage": {
"type": "number",
"description": "Percentage associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"quantity": {
"type": "number",
"description": "Quantity associated to the line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"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
}
}
}
}
}
}
},
"journal_currency": {
"type": "object",
"description": "Currency information",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"currency_id": {
"type": "string",
"description": "Associated currency",
"x-sage-entitylink": "currencies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"currency_amount": {
"type": "number",
"description": "Associated amount",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"currency_rate": {
"type": "number",
"description": "Associated rate",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"journal_buildings": {
"type": "array",
"description": "List of journal building",
"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": true,
"x-sage-orderable": false
},
"catastral_reference": {
"type": "string",
"description": "Catastral reference",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"building_status": {
"type": "string",
"description": "Building status",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"base": {
"type": "number",
"description": "Taxable base of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate": {
"type": "number",
"description": "Tax VAT of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax Amount VAT of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax VAT_surcharge of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_base": {
"type": "number",
"description": "Base for the income tax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate": {
"type": "number",
"description": "Percent INCOME_TAX of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_amount": {
"type": "number",
"description": "Amount income tax of jounal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_type": {
"type": "string",
"description": "Type income tax of jounal building. See <a href=\"/docs#/spain/s200/accounts/v1/incometaxtype\">incometaxtype</a>",
"readOnly": false,
"x-sage-enumlink": "incometaxtype",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "timestamp of the Journal Entris",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"journal_entry_type": {
"type": "string",
"description": "Journal entry type. See <a href=\"/docs#/spain/s200/accounts/v1/journalentrytype\">journalentrytype</a>",
"readOnly": false,
"x-sage-enumlink": "journalentrytype",
"enum": [
"3",
"4",
"5",
"6",
"1",
"2"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"description": "Notes of the Journal Entries",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}Response 200
OK.
{
"id": "string",
"company_id": "string",
"journal_id": "string",
"application_id": "string",
"date": "string",
"journal_lines": [
{
"id": "string",
"account_id": "string",
"account_opposite_id": "string",
"description": "string",
"accounting_sign": "1",
"amount": 0.0,
"reference": "string",
"quantity": 0.0,
"reconcilation_code": "string",
"journal_third_party": {
"customer_id": "string",
"supplier_id": "string",
"other_third_party_id": "string"
},
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"journal_documents": [
{
"id": "string",
"period": "string",
"serial": "string",
"number": "string",
"issue_date": "string",
"document_type": "3",
"due_date": "string",
"identity_type": "1",
"identity": "string",
"name": "string",
"external_reference": "string",
"amount": 0.0,
"operation_code": "0",
"operation_date": "string",
"income_tax_base": 0.0,
"income_tax_id": "string",
"income_tax_rate": 0.0,
"income_tax_amount": 0.0,
"income_tax_type": "0",
"number_initial_document": "string",
"number_final_document": "string",
"total_number_document": 0,
"vat_type_system": "0"
}
],
"journal_taxes": [
{
"id": "string",
"vat_tax_rate_id": "string",
"base": 0.0,
"vat_tax_rate": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_rate": 0.0,
"surcharge_tax_amount": 0.0,
"total_tax_amount": 0.0,
"transaction_code": "1"
}
],
"journal_payments": [
{
"id": "string",
"document_id": "string",
"period": "string",
"serial": "string",
"number": 0,
"amount": 0.0,
"bank_account": {
"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"
}
]
},
"type": "1",
"payment_method_id": "string",
"bank_statement": "string",
"code_means_charge": "1",
"means_charge": "string"
}
],
"journal_analytics": [
{
"id": "string",
"cost_centers": [
"string"
],
"amount": 0.0,
"percentage": 0.0,
"quantity": 0.0,
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"journal_currency": {
"currency_id": "string",
"currency_amount": 0.0,
"currency_rate": 0.0
},
"journal_buildings": [
{
"id": "string",
"catastral_reference": "string",
"building_status": "string",
"base": 0.0,
"vat_tax_rate": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_rate": 0.0,
"surcharge_tax_amount": 0.0,
"income_tax_base": 0.0,
"income_tax_rate": 0.0,
"income_tax_amount": 0.0,
"income_tax_type": "0"
}
]
}
],
"timestamp": "string",
"journal_entry_type": "3",
"notes": "string"
}{
"type": "object",
"description": "List of Journal entries of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Journal",
"x-sage-relatedopeations": [
"companies",
"journals"
],
"required": [
"company_id",
"date"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier Journal entry",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"company_id": {
"type": "string",
"description": "Company ID of the Journal entry",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"journal_id": {
"type": "string",
"description": "Type of journal",
"x-sage-entitylink": "journals",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"application_id": {
"type": "string",
"description": "Application ID of the Journal entry",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of Jounal entry",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"journal_lines": {
"type": "array",
"description": "Journal lines details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier Journal line of accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"account_id": {
"type": "string",
"description": "Account ID of Journal Line",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_opposite_id": {
"type": "string",
"description": "Account opposite ID of Journal Line",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"description": {
"type": "string",
"description": "Description of the Journal Line",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"accounting_sign": {
"type": "string",
"description": "Sign of the Journal Line. See <a href=\"/docs#/spain/s200/accounts/v1/accountingsigntype\">accountingsigntype</a>",
"readOnly": false,
"x-sage-enumlink": "accountingsigntype",
"enum": [
"1",
"2"
],
"x-sage-queryable": true,
"x-sage-orderable": true
},
"amount": {
"type": "number",
"description": "Amount of Journal Line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"reference": {
"type": "string",
"description": "Reference of the line",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"quantity": {
"type": "number",
"description": "Quantity associated to the line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"reconcilation_code": {
"type": "string",
"description": "Reconciliation code number",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"journal_third_party": {
"type": "object",
"description": "Associated third party",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"customer_id": {
"type": "string",
"description": "Associated customer",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"supplier_id": {
"type": "string",
"description": "Associated supplier",
"x-sage-entitylink": "suppliers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"other_third_party_id": {
"type": "string",
"description": "Other third parties",
"x-sage-entitylink": "other_third_parties",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
}
}
},
"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
}
}
}
},
"journal_documents": {
"type": "array",
"description": "List of valid journal invoices associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID Invoice of accounts invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"period": {
"type": "string",
"description": "Period of the document (fiscal year)",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"serial": {
"type": "string",
"description": "Serial of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"issue_date": {
"type": "string",
"format": "date-time",
"description": "Date of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"document_type": {
"type": "string",
"description": "Type of accounts document. See <a href=\"/docs#/spain/s200/accounts/v1/documenttype\">documenttype</a>",
"readOnly": false,
"x-sage-enumlink": "documenttype",
"enum": [
"3",
"1",
"2"
],
"x-sage-queryable": true,
"x-sage-orderable": false
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Due date of the document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"identity_type": {
"type": "string",
"description": "Type of tax document of accounts document. 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 accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "description of the operation",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"external_reference": {
"type": "string",
"description": "External reference of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"amount": {
"type": "number",
"description": "Amount of accounts document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"operation_code": {
"type": "string",
"description": "Operation code of accounts document. See <a href=\"/docs#/spain/s200/accounts/v1/codeoperationtype\">codeoperationtype</a>",
"readOnly": false,
"x-sage-enumlink": "codeoperationtype",
"enum": [
"0",
"A",
"B",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"C"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"operation_date": {
"type": "string",
"format": "date-time",
"description": "Date of operation of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"income_tax_base": {
"type": "number",
"description": "Base for the income tax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_id": {
"type": "string",
"description": "Income tax id",
"x-sage-entitylink": "income_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate": {
"type": "number",
"description": "Percent INCOME_TAX of sales document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_amount": {
"type": "number",
"description": "Tax INCOME_TAX of sales document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_type": {
"type": "string",
"description": "Legal income tax type. See <a href=\"/docs#/spain/s200/accounts/v1/incometaxtype\">incometaxtype</a>",
"readOnly": false,
"x-sage-enumlink": "incometaxtype",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number_initial_document": {
"type": "string",
"description": "Number initial document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number_final_document": {
"type": "string",
"description": "Number Final Document",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total_number_document": {
"type": "integer",
"format": "int32",
"description": "Total Number documents",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_type_system": {
"type": "string",
"description": "Type VAT system. See <a href=\"/docs#/spain/s200/accounts/v1/vattypecaja\">vattypecaja</a>",
"readOnly": false,
"x-sage-enumlink": "vattypecaja",
"enum": [
"0",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"journal_taxes": {
"type": "array",
"description": "List of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID Invoice Taxes of accounts",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate_id": {
"type": "string",
"description": "Tax rate id",
"x-sage-entitylink": "vat_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"base": {
"type": "number",
"description": "Taxable base of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate": {
"type": "number",
"description": "Tax VAT of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax Amount VAT of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax VAT_surcharge of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of accounts invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total_tax_amount": {
"type": "number",
"description": "Total taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"transaction_code": {
"type": "string",
"description": "invoice transaction code. See <a href=\"/docs#/spain/s200/accounts/v1/codetransactiontype\">codetransactiontype</a>",
"readOnly": false,
"x-sage-enumlink": "codetransactiontype",
"enum": [
"1",
"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",
"31",
"32",
"33",
"35",
"36",
"37",
"38",
"39",
"40",
"42",
"47",
"49",
"51",
"53",
"54",
"55",
"56",
"57",
"58",
"59",
"60",
"61"
],
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"journal_payments": {
"type": "array",
"description": "List of valid journal payments associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of payments",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"document_id": {
"type": "string",
"description": "Id Invoice of accounts payments",
"x-sage-entitylink": "journal_documents",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"period": {
"type": "string",
"description": "invoice payed period",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"serial": {
"type": "string",
"description": "invoice payed serial",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"number": {
"type": "integer",
"format": "int64",
"description": "invoice payed number",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"amount": {
"type": "number",
"description": "Amount of accounts payments",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_account": {
"type": "object",
"description": "Bank account of accounts payments",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"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
}
}
}
}
}
},
"type": {
"type": "string",
"description": "type of accounts payments. See <a href=\"/docs#/spain/s200/accounts/v1/paymenttype\">paymenttype</a>",
"readOnly": false,
"x-sage-enumlink": "paymenttype",
"enum": [
"1",
"2"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"description": "Id of the payment method",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_statement": {
"type": "string",
"description": "Bank statement for conciliating",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"code_means_charge": {
"type": "string",
"description": "Codigo Medio Cobro. See <a href=\"/docs#/spain/s200/accounts/v1/codemeanscharge\">codemeanscharge</a>",
"readOnly": false,
"x-sage-enumlink": "codemeanscharge",
"enum": [
"1",
"2",
"3"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"means_charge": {
"type": "string",
"description": "Medio cobro",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"journal_analytics": {
"type": "array",
"description": "List of analytical information",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the analytics",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"cost_centers": {
"type": "array",
"description": "Cost centers associated",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"amount": {
"type": "number",
"description": "Amount associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"percentage": {
"type": "number",
"description": "Percentage associated",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"quantity": {
"type": "number",
"description": "Quantity associated to the line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"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
}
}
}
}
}
}
},
"journal_currency": {
"type": "object",
"description": "Currency information",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"currency_id": {
"type": "string",
"description": "Associated currency",
"x-sage-entitylink": "currencies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"currency_amount": {
"type": "number",
"description": "Associated amount",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"currency_rate": {
"type": "number",
"description": "Associated rate",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"journal_buildings": {
"type": "array",
"description": "List of journal building",
"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": true,
"x-sage-orderable": false
},
"catastral_reference": {
"type": "string",
"description": "Catastral reference",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"building_status": {
"type": "string",
"description": "Building status",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"base": {
"type": "number",
"description": "Taxable base of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate": {
"type": "number",
"description": "Tax VAT of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax Amount VAT of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax VAT_surcharge of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_base": {
"type": "number",
"description": "Base for the income tax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate": {
"type": "number",
"description": "Percent INCOME_TAX of journal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_amount": {
"type": "number",
"description": "Amount income tax of jounal building",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_type": {
"type": "string",
"description": "Type income tax of jounal building. See <a href=\"/docs#/spain/s200/accounts/v1/incometaxtype\">incometaxtype</a>",
"readOnly": false,
"x-sage-enumlink": "incometaxtype",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "timestamp of the Journal Entris",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"journal_entry_type": {
"type": "string",
"description": "Journal entry type. See <a href=\"/docs#/spain/s200/accounts/v1/journalentrytype\">journalentrytype</a>",
"readOnly": false,
"x-sage-enumlink": "journalentrytype",
"enum": [
"3",
"4",
"5",
"6",
"1",
"2"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"description": "Notes of the Journal Entries",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}Code samples
@ECHO OFF
curl -v -X PUT "https://api.columbus.sage.com/es/s200/accounts/v1/journal_entries/{id}"
-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/journal_entries/{id}?" + 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.PutAsync(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/journal_entries/{id}");
URI uri = builder.build();
HttpPut request = new HttpPut(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/journal_entries/{id}?" + $.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: "PUT",
// 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/journal_entries/{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:@"PUT"];
// 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/journal_entries/{id}');
$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_PUT);
// 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("PUT", "/es/s200/accounts/v1/journal_entries/{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
'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("PUT", "/es/s200/accounts/v1/journal_entries/{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/es/s200/accounts/v1/journal_entries/{id}')
request = Net::HTTP::Put.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