Sage 200 - Sales
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. Sales API exposes resources of Sage 200 related to sales process such as customers, items, quotes, orders, delivery notes, invoices, receipts and payments. Typical integrations use cases are e-commerce, mobile sales, catalogues, invoice brokers, point of sales.
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 sales invoices of the company
{
"id": "string",
"company_id": "string",
"type": "1",
"period": "string",
"serial": "string",
"number": 0,
"date": "string",
"customer_id": "string",
"customer_name": "string",
"customer_identity_type": "1",
"customer_identity": "string",
"currency": "string",
"currency_change_rate": 0.0,
"tax_type": "1",
"included_vat": true,
"payment_method_id": "string",
"sales_person_id": "string",
"commission_percent": 0.0,
"discount_percent": 0.0,
"discount_payment_method_percent": 0.0,
"discount_amount_rappel_percent": 0.0,
"income_tax_rate_id": "string",
"income_tax_rate": 0.0,
"your_sales_invoice_number": "string",
"printed": true,
"sent": true,
"signed": true,
"paid_amount": 0.0,
"price_type_id": "string",
"charges_total": 0.0,
"commission_amount": 0.0,
"discount_amount": 0.0,
"discount_payment_method_amount": 0.0,
"discount_amount_rappel_amount": 0.0,
"income_tax_amount": 0.0,
"net_total": 0.0,
"tax_total": 0.0,
"total": 0.0,
"notes": "string",
"sales_invoice_corrective_details": {
"corrected_invoices": [
"string"
],
"reason_code": "1",
"reason_description": "string",
"correction_method": "1",
"correction_method_description": "string"
},
"sales_invoice_fiscal_details": {
"customer_email": "string",
"customer_telephone": "string",
"customer_mobile": "string",
"customer_fax": "string",
"customer_name_of_legal_representative": "string",
"customer_identity_of_legal_representative": "string",
"type_street": "0",
"street": "string",
"number": "string",
"stair": "string",
"floor": "string",
"door": "string",
"letter": "string",
"full_address": "string",
"locality_name": "string",
"region_name": "string",
"postal_code": "string",
"country_name": "string"
},
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"sales_invoice_lines": [
{
"id": "string",
"sales_delivery_line_id": "string",
"order": 0,
"item_set_id": "string",
"item_id": "string",
"item_barcode": "string",
"item_description": "string",
"item_long_description": "string",
"properties": [
{
"item_property_id": "string",
"value": "string",
"group": "string"
}
],
"vat_tax_rate": 0.0,
"surcharge_tax_rate": 0.0,
"quantity": 0.0,
"price": 0.0,
"item_discount_percent": 0.0,
"commission_percent": 0.0,
"line_included_vat": true,
"location_id": "string",
"item_discount_amount": 0.0,
"net_total": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_amount": 0.0,
"total": 0.0,
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"sales_invoice_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
}
],
"receipts": [
{
"id": "string",
"company_id": "string",
"invoice_id": "string",
"order": 0.0,
"date": "string",
"due_date": "string",
"customer_id": "string",
"status": "1",
"iban": "string",
"total": 0.0,
"description": "string",
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"timestamp": "string",
"customer_commercial_name": "string"
}{
"type": "object",
"description": "List of sales invoices of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Invoices",
"x-sage-relatedopeations": [
"companies",
"customers",
"contacts",
"item_type_prices",
"payment_methods",
"zones",
"sales_persons",
"cost_centers",
"customer_groups",
"income_tax_rates",
"sales_receipts",
"sales_invoices"
],
"required": [
"company_id",
"customer_id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of sales Invoice",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type": {
"type": "string",
"description": "Type sales invoice. See <a href=\"/docs#/spain/s200/sales/v1/invoicetype\">invoicetype</a>",
"readOnly": false,
"x-sage-enumlink": "invoicetype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": true,
"x-sage-orderable": true
},
"period": {
"type": "string",
"description": "Period of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"serial": {
"type": "string",
"maxLength": 10,
"description": "Serial of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"number": {
"type": "integer",
"format": "int64",
"description": "Number of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_id": {
"type": "string",
"maxLength": 16,
"description": "Id Customer of sales Invoice",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_name": {
"type": "string",
"maxLength": 40,
"description": "Name of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_identity_type": {
"type": "string",
"description": "Tye of tax document of the Customer. See <a href=\"/docs#/spain/s200/sales/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
},
"customer_identity": {
"type": "string",
"maxLength": 128,
"description": "VAT number / Tax ID Number of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "Sales order Currency of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"currency_change_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Currency Change Rate of the Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"tax_type": {
"type": "string",
"description": "Tax reference of sales Invoice. See <a href=\"/docs#/spain/s200/sales/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"included_vat": {
"type": "boolean",
"description": "Included VAT of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"maxLength": 16,
"description": "Id paymentmethod of sales Invoice",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_person_id": {
"type": "string",
"maxLength": 16,
"description": "Id Sale persons of sales Invoice",
"x-sage-entitylink": "sales_persons",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"commission_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percentege Commission of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_payment_method_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount_rappel_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent Discount Amount Rappel of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate_id": {
"type": "string",
"maxLength": 16,
"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",
"format": "integer 3 decimal 2 dp",
"description": "Percent INCOME_TAX of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"your_sales_invoice_number": {
"type": "string",
"description": "Your order of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"printed": {
"type": "boolean",
"description": "Status printed of sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sent": {
"type": "boolean",
"description": "Status sent of sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"signed": {
"type": "boolean",
"description": "Status signed of sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"paid_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount Paid of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"price_type_id": {
"type": "string",
"description": "Prices type",
"x-sage-entitylink": "item_type_prices",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"charges_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount Charges of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"commission_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount Commission of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount discount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_payment_method_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount discount payment method of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount_rappel_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Discount Rappel Amount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax INCOME_TAX of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"net_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Net Total of of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"tax_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total Tax of of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"maxLength": 50,
"description": "Notes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_invoice_corrective_details": {
"type": "object",
"description": "corrective details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"corrected_invoices": {
"type": "array",
"description": "list of invoice id's",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"reason_code": {
"type": "string",
"description": "Numerical code of the reason for correction. '01' to '16'\r\nerrors according to regulation RD 1496/2003; '80' to '85'\r\nerrors according to Art. 80 Law 37/92 on the VAT.. See <a href=\"/docs#/spain/s200/sales/v1/refundreasoncodetype\">refundreasoncodetype</a>",
"readOnly": false,
"x-sage-enumlink": "refundreasoncodetype",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"80",
"81",
"82",
"83",
"84",
"85"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"reason_description": {
"type": "string",
"description": "Description of the reason for correction according to each\r\ncode. See table of codes and descriptions.",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"correction_method": {
"type": "string",
"description": "Numerical code to identify the method applied to correct an\r\ninvoice. “01” – all items to be corrected in the original. See <a href=\"/docs#/spain/s200/sales/v1/correctionmethod\">correctionmethod</a>",
"readOnly": false,
"x-sage-enumlink": "correctionmethod",
"enum": [
"1",
"2"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"correction_method_description": {
"type": "string",
"description": "Description of the correction method",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"sales_invoice_fiscal_details": {
"type": "object",
"description": "fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"customer_email": {
"type": "string",
"maxLength": 250,
"description": "customer_email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_telephone": {
"type": "string",
"maxLength": 15,
"description": "Customer telephone of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_mobile": {
"type": "string",
"maxLength": 15,
"description": "customer_mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_fax": {
"type": "string",
"maxLength": 15,
"description": "customer_fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_name_of_legal_representative": {
"type": "string",
"maxLength": 16,
"description": "Customer name of legal representative of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_identity_of_legal_representative": {
"type": "string",
"maxLength": 128,
"description": "customer_identity_of_legal_representative",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street of invoice fiscal details. See <a href=\"/docs#/spain/s200/sales/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"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"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"maxLength": 40,
"description": "Street of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"maxLength": 2,
"description": "Stair of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"maxLength": 2,
"description": "Floor of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"maxLength": 2,
"description": "Door of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"maxLength": 2,
"description": "Letter of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"maxLength": 40,
"description": "Full address of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality_name": {
"type": "string",
"maxLength": 25,
"description": "Locality name of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region_name": {
"type": "string",
"maxLength": 20,
"description": "Region name of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"postal_code": {
"type": "string",
"maxLength": 8,
"description": "Postal code of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country_name": {
"type": "string",
"maxLength": 25,
"description": "country_name",
"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 free 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
}
}
}
},
"sales_invoice_lines": {
"type": "array",
"description": "List of sales invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of the sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_delivery_line_id": {
"type": "string",
"maxLength": 16,
"description": "Sales delivery lines ID relation delivery",
"x-sage-entitylink": "sales_delivery_lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"order": {
"type": "integer",
"format": "int32",
"description": "Presentation order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_set_id": {
"type": "string",
"maxLength": 16,
"description": "Set id",
"x-sage-entitylink": "item_sets",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_id": {
"type": "string",
"maxLength": 16,
"description": "ID Items of sales Invoice lines",
"x-sage-entitylink": "items",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_barcode": {
"type": "string",
"maxLength": 20,
"description": "Items Barcode of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_description": {
"type": "string",
"maxLength": 50,
"description": "Items Description of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_long_description": {
"type": "string",
"description": "Items Description Long of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"properties": {
"type": "array",
"description": "Property value list of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"item_property_id": {
"type": "string",
"description": "Property id",
"x-sage-entitylink": "item_properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "Value",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"group": {
"type": "string",
"description": "Group of the Property",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
}
}
}
},
"vat_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent tax of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax Surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"quantity": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Quantity of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"price": {
"type": "number",
"format": "integer 10 decimal 2 dp",
"description": "Sales price of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"commission_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent Commission of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"line_included_vat": {
"type": "boolean",
"description": "Lines Included VAT of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"location_id": {
"type": "string",
"maxLength": 16,
"description": "ID Location of sales",
"x-sage-entitylink": "locations",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Discount line of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"net_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total net of the line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax amount of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT_surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Linea amount of sales Invoice lines",
"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 free 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
}
}
}
}
}
}
},
"sales_invoice_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",
"maxLength": 128,
"description": "ID of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate_id": {
"type": "string",
"maxLength": 16,
"description": "Tax rate id",
"x-sage-entitylink": "vat_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"base": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Taxable base of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax VAT of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax VAT_surcharge of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT_surcharge of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"receipts": {
"type": "array",
"description": "List of Receipt of sales Invoice",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"description": "List of Receipt of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Payments",
"x-sage-relatedopeations": [
"companies",
"sales_invoices",
"customers",
"contacts",
"item_type_prices",
"payment_methods",
"zones",
"sales_persons",
"cost_centers",
"customer_groups",
"income_tax_rates",
"sales_receipts"
],
"required": [
"company_id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of sales receipt",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"invoice_id": {
"type": "string",
"description": "ID invoice of sales receipt",
"x-sage-entitylink": "sales_invoices",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"order": {
"type": "number",
"description": "Counter of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Due Date of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_id": {
"type": "string",
"description": "Id Customer of sales receipt",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"status": {
"type": "string",
"description": "State of sales receipt. See <a href=\"/docs#/spain/s200/sales/v1/receiptstatustype\">receiptstatustype</a>",
"readOnly": false,
"x-sage-enumlink": "receiptstatustype",
"enum": [
"1",
"2",
"3"
],
"x-sage-queryable": true,
"x-sage-orderable": true
},
"iban": {
"type": "string",
"maxLength": 34,
"description": "IBAN of sales receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total of sales receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"description": {
"type": "string",
"maxLength": 40,
"description": "Coments on the receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"extended_properties": {
"type": "array",
"description": "List of free 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
}
}
}
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_commercial_name": {
"type": "string",
"maxLength": 40,
"description": "Commercial name of the Customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}Response 201
OK. Resource created.
{
"id": "string",
"company_id": "string",
"type": "1",
"period": "string",
"serial": "string",
"number": 0,
"date": "string",
"customer_id": "string",
"customer_name": "string",
"customer_identity_type": "1",
"customer_identity": "string",
"currency": "string",
"currency_change_rate": 0.0,
"tax_type": "1",
"included_vat": true,
"payment_method_id": "string",
"sales_person_id": "string",
"commission_percent": 0.0,
"discount_percent": 0.0,
"discount_payment_method_percent": 0.0,
"discount_amount_rappel_percent": 0.0,
"income_tax_rate_id": "string",
"income_tax_rate": 0.0,
"your_sales_invoice_number": "string",
"printed": true,
"sent": true,
"signed": true,
"paid_amount": 0.0,
"price_type_id": "string",
"charges_total": 0.0,
"commission_amount": 0.0,
"discount_amount": 0.0,
"discount_payment_method_amount": 0.0,
"discount_amount_rappel_amount": 0.0,
"income_tax_amount": 0.0,
"net_total": 0.0,
"tax_total": 0.0,
"total": 0.0,
"notes": "string",
"sales_invoice_corrective_details": {
"corrected_invoices": [
"string"
],
"reason_code": "1",
"reason_description": "string",
"correction_method": "1",
"correction_method_description": "string"
},
"sales_invoice_fiscal_details": {
"customer_email": "string",
"customer_telephone": "string",
"customer_mobile": "string",
"customer_fax": "string",
"customer_name_of_legal_representative": "string",
"customer_identity_of_legal_representative": "string",
"type_street": "0",
"street": "string",
"number": "string",
"stair": "string",
"floor": "string",
"door": "string",
"letter": "string",
"full_address": "string",
"locality_name": "string",
"region_name": "string",
"postal_code": "string",
"country_name": "string"
},
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"sales_invoice_lines": [
{
"id": "string",
"sales_delivery_line_id": "string",
"order": 0,
"item_set_id": "string",
"item_id": "string",
"item_barcode": "string",
"item_description": "string",
"item_long_description": "string",
"properties": [
{
"item_property_id": "string",
"value": "string",
"group": "string"
}
],
"vat_tax_rate": 0.0,
"surcharge_tax_rate": 0.0,
"quantity": 0.0,
"price": 0.0,
"item_discount_percent": 0.0,
"commission_percent": 0.0,
"line_included_vat": true,
"location_id": "string",
"item_discount_amount": 0.0,
"net_total": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_amount": 0.0,
"total": 0.0,
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"sales_invoice_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
}
],
"receipts": [
{
"id": "string",
"company_id": "string",
"invoice_id": "string",
"order": 0.0,
"date": "string",
"due_date": "string",
"customer_id": "string",
"status": "1",
"iban": "string",
"total": 0.0,
"description": "string",
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"timestamp": "string",
"customer_commercial_name": "string"
}{
"type": "object",
"description": "List of sales invoices of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Invoices",
"x-sage-relatedopeations": [
"companies",
"customers",
"contacts",
"item_type_prices",
"payment_methods",
"zones",
"sales_persons",
"cost_centers",
"customer_groups",
"income_tax_rates",
"sales_receipts",
"sales_invoices"
],
"required": [
"company_id",
"customer_id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of sales Invoice",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type": {
"type": "string",
"description": "Type sales invoice. See <a href=\"/docs#/spain/s200/sales/v1/invoicetype\">invoicetype</a>",
"readOnly": false,
"x-sage-enumlink": "invoicetype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": true,
"x-sage-orderable": true
},
"period": {
"type": "string",
"description": "Period of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"serial": {
"type": "string",
"maxLength": 10,
"description": "Serial of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"number": {
"type": "integer",
"format": "int64",
"description": "Number of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_id": {
"type": "string",
"maxLength": 16,
"description": "Id Customer of sales Invoice",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_name": {
"type": "string",
"maxLength": 40,
"description": "Name of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_identity_type": {
"type": "string",
"description": "Tye of tax document of the Customer. See <a href=\"/docs#/spain/s200/sales/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
},
"customer_identity": {
"type": "string",
"maxLength": 128,
"description": "VAT number / Tax ID Number of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "Sales order Currency of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"currency_change_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Currency Change Rate of the Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"tax_type": {
"type": "string",
"description": "Tax reference of sales Invoice. See <a href=\"/docs#/spain/s200/sales/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"included_vat": {
"type": "boolean",
"description": "Included VAT of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"maxLength": 16,
"description": "Id paymentmethod of sales Invoice",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_person_id": {
"type": "string",
"maxLength": 16,
"description": "Id Sale persons of sales Invoice",
"x-sage-entitylink": "sales_persons",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"commission_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percentege Commission of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_payment_method_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount_rappel_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent Discount Amount Rappel of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate_id": {
"type": "string",
"maxLength": 16,
"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",
"format": "integer 3 decimal 2 dp",
"description": "Percent INCOME_TAX of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"your_sales_invoice_number": {
"type": "string",
"description": "Your order of sales Invoice",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"printed": {
"type": "boolean",
"description": "Status printed of sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sent": {
"type": "boolean",
"description": "Status sent of sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"signed": {
"type": "boolean",
"description": "Status signed of sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"paid_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount Paid of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"price_type_id": {
"type": "string",
"description": "Prices type",
"x-sage-entitylink": "item_type_prices",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"charges_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount Charges of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"commission_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount Commission of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount discount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_payment_method_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount discount payment method of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount_rappel_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Discount Rappel Amount of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax INCOME_TAX of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"net_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Net Total of of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"tax_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total Tax of of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total of sales Invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"maxLength": 50,
"description": "Notes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_invoice_corrective_details": {
"type": "object",
"description": "corrective details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"corrected_invoices": {
"type": "array",
"description": "list of invoice id's",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"reason_code": {
"type": "string",
"description": "Numerical code of the reason for correction. '01' to '16'\r\nerrors according to regulation RD 1496/2003; '80' to '85'\r\nerrors according to Art. 80 Law 37/92 on the VAT.. See <a href=\"/docs#/spain/s200/sales/v1/refundreasoncodetype\">refundreasoncodetype</a>",
"readOnly": false,
"x-sage-enumlink": "refundreasoncodetype",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"80",
"81",
"82",
"83",
"84",
"85"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"reason_description": {
"type": "string",
"description": "Description of the reason for correction according to each\r\ncode. See table of codes and descriptions.",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"correction_method": {
"type": "string",
"description": "Numerical code to identify the method applied to correct an\r\ninvoice. “01” – all items to be corrected in the original. See <a href=\"/docs#/spain/s200/sales/v1/correctionmethod\">correctionmethod</a>",
"readOnly": false,
"x-sage-enumlink": "correctionmethod",
"enum": [
"1",
"2"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"correction_method_description": {
"type": "string",
"description": "Description of the correction method",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"sales_invoice_fiscal_details": {
"type": "object",
"description": "fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"customer_email": {
"type": "string",
"maxLength": 250,
"description": "customer_email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_telephone": {
"type": "string",
"maxLength": 15,
"description": "Customer telephone of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_mobile": {
"type": "string",
"maxLength": 15,
"description": "customer_mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_fax": {
"type": "string",
"maxLength": 15,
"description": "customer_fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_name_of_legal_representative": {
"type": "string",
"maxLength": 16,
"description": "Customer name of legal representative of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_identity_of_legal_representative": {
"type": "string",
"maxLength": 128,
"description": "customer_identity_of_legal_representative",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street of invoice fiscal details. See <a href=\"/docs#/spain/s200/sales/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"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"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"maxLength": 40,
"description": "Street of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"maxLength": 2,
"description": "Stair of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"maxLength": 2,
"description": "Floor of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"maxLength": 2,
"description": "Door of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"maxLength": 2,
"description": "Letter of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"maxLength": 40,
"description": "Full address of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality_name": {
"type": "string",
"maxLength": 25,
"description": "Locality name of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region_name": {
"type": "string",
"maxLength": 20,
"description": "Region name of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"postal_code": {
"type": "string",
"maxLength": 8,
"description": "Postal code of invoice fiscal details",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country_name": {
"type": "string",
"maxLength": 25,
"description": "country_name",
"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 free 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
}
}
}
},
"sales_invoice_lines": {
"type": "array",
"description": "List of sales invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of the sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_delivery_line_id": {
"type": "string",
"maxLength": 16,
"description": "Sales delivery lines ID relation delivery",
"x-sage-entitylink": "sales_delivery_lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"order": {
"type": "integer",
"format": "int32",
"description": "Presentation order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_set_id": {
"type": "string",
"maxLength": 16,
"description": "Set id",
"x-sage-entitylink": "item_sets",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_id": {
"type": "string",
"maxLength": 16,
"description": "ID Items of sales Invoice lines",
"x-sage-entitylink": "items",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_barcode": {
"type": "string",
"maxLength": 20,
"description": "Items Barcode of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_description": {
"type": "string",
"maxLength": 50,
"description": "Items Description of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_long_description": {
"type": "string",
"description": "Items Description Long of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"properties": {
"type": "array",
"description": "Property value list of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"item_property_id": {
"type": "string",
"description": "Property id",
"x-sage-entitylink": "item_properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "Value",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"group": {
"type": "string",
"description": "Group of the Property",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
}
}
}
},
"vat_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent tax of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax Surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"quantity": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Quantity of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"price": {
"type": "number",
"format": "integer 10 decimal 2 dp",
"description": "Sales price of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"commission_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent Commission of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"line_included_vat": {
"type": "boolean",
"description": "Lines Included VAT of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"location_id": {
"type": "string",
"maxLength": 16,
"description": "ID Location of sales",
"x-sage-entitylink": "locations",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Discount line of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"net_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total net of the line",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax amount of sales Invoice lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT_surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Linea amount of sales Invoice lines",
"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 free 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
}
}
}
}
}
}
},
"sales_invoice_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",
"maxLength": 128,
"description": "ID of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate_id": {
"type": "string",
"maxLength": 16,
"description": "Tax rate id",
"x-sage-entitylink": "vat_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"base": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Taxable base of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax VAT of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax VAT_surcharge of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT_surcharge of sales invoice taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"receipts": {
"type": "array",
"description": "List of Receipt of sales Invoice",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"description": "List of Receipt of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Payments",
"x-sage-relatedopeations": [
"companies",
"sales_invoices",
"customers",
"contacts",
"item_type_prices",
"payment_methods",
"zones",
"sales_persons",
"cost_centers",
"customer_groups",
"income_tax_rates",
"sales_receipts"
],
"required": [
"company_id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of sales receipt",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"invoice_id": {
"type": "string",
"description": "ID invoice of sales receipt",
"x-sage-entitylink": "sales_invoices",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"order": {
"type": "number",
"description": "Counter of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Due Date of sales receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_id": {
"type": "string",
"description": "Id Customer of sales receipt",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"status": {
"type": "string",
"description": "State of sales receipt. See <a href=\"/docs#/spain/s200/sales/v1/receiptstatustype\">receiptstatustype</a>",
"readOnly": false,
"x-sage-enumlink": "receiptstatustype",
"enum": [
"1",
"2",
"3"
],
"x-sage-queryable": true,
"x-sage-orderable": true
},
"iban": {
"type": "string",
"maxLength": 34,
"description": "IBAN of sales receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total of sales receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"description": {
"type": "string",
"maxLength": 40,
"description": "Coments on the receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"extended_properties": {
"type": "array",
"description": "List of free 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
}
}
}
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the sales invoice",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_commercial_name": {
"type": "string",
"maxLength": 40,
"description": "Commercial name of the Customer",
"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/sales/v1/sales_invoices"
-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/sales/v1/sales_invoices?" + 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/sales/v1/sales_invoices");
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/sales/v1/sales_invoices?" + $.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/sales/v1/sales_invoices";
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/sales/v1/sales_invoices');
$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/sales/v1/sales_invoices?%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/sales/v1/sales_invoices?%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/sales/v1/sales_invoices')
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