FacturaPlus - 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 deliveries of the company
{
"id": "string",
"company_id": "string",
"period": "string",
"serial": "string",
"number": 0,
"date": "string",
"delivery_date": "string",
"customer_id": "string",
"status": "1",
"currency": "string",
"currency_change_rate": 0.0,
"tax_type": "1",
"included_vat": true,
"address_id": "string",
"delivery_address_id": "string",
"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_delivery_number": "string",
"advance_payment": {
"amount": 0.0,
"date": "string",
"payment_method_id": "string"
},
"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,
"net_total": 0.0,
"tax_total": 0.0,
"income_tax_amount": 0.0,
"total": 0.0,
"notes": "string",
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"sales_delivery_lines": [
{
"id": "string",
"sales_order_lines_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_line_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_delivery_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
}
],
"timestamp": "string"
}{
"type": "object",
"description": "List of sales deliveries of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Deliveries",
"x-sage-relatedopeations": [
"companies",
"customers",
"contacts",
"item_type_prices",
"payment_methods",
"zones",
"sales_persons",
"cost_centers",
"customer_groups",
"income_tax_rates"
],
"required": [
"company_id",
"customer_id"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the sales Delivery",
"readOnly": false
},
"company_id": {
"type": "string",
"description": "Company ID of sales Delivery",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"period": {
"type": "string",
"description": "Period Sales delivery of sales Delivery",
"readOnly": false
},
"serial": {
"type": "string",
"description": "Serial of sales Delivery",
"readOnly": false
},
"number": {
"type": "integer",
"format": "int64",
"description": "Number of sales Delivery",
"readOnly": false
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of sales Delivery",
"readOnly": false
},
"delivery_date": {
"type": "string",
"format": "date-time",
"description": "Delivery date of sales Delivery",
"readOnly": false
},
"customer_id": {
"type": "string",
"description": "Id Customer of sales Delivery",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"status": {
"type": "string",
"description": "Status of the document. See <a href=\"/docs#/spain/facturaplus/sales/v1/documentstatustype\">documentstatustype</a>",
"readOnly": false,
"x-sage-enumlink": "documentstatustype",
"enum": [
"1",
"2"
]
},
"currency": {
"type": "string",
"description": "Currency of sales Delivery",
"readOnly": false
},
"currency_change_rate": {
"type": "number",
"description": "Currency Change Rate of sales Delivery",
"readOnly": false
},
"tax_type": {
"type": "string",
"description": "Tax reference of sales Delivery. See <a href=\"/docs#/spain/facturaplus/sales/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
]
},
"included_vat": {
"type": "boolean",
"description": "Include VAT of sales Delivery",
"readOnly": false
},
"address_id": {
"type": "string",
"description": "Id Address of sales Delivery",
"x-sage-entitylink": "addresses",
"readOnly": false
},
"delivery_address_id": {
"type": "string",
"description": "Id Delivery Address of sales Delivery",
"x-sage-entitylink": "addresses",
"readOnly": false
},
"payment_method_id": {
"type": "string",
"description": "Id paymentmethod of sale Delivery",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_person_id": {
"type": "string",
"description": "Id Sales persons of sales Delivery",
"x-sage-entitylink": "sales_persons",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"commission_percent": {
"type": "number",
"description": "Commission Percent of sales Delivery",
"readOnly": false
},
"discount_percent": {
"type": "number",
"description": "Percent discount of sales Delivery",
"readOnly": false
},
"discount_payment_method_percent": {
"type": "number",
"description": "Percent discount of sales Delivery",
"readOnly": false
},
"discount_amount_rappel_percent": {
"type": "number",
"description": "Percent Discount Amount Rappel of sales Delivery",
"readOnly": false
},
"income_tax_rate_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 sale Delivery",
"readOnly": false
},
"your_sales_delivery_number": {
"type": "string",
"description": "Your order of sales Delivery",
"readOnly": false
},
"advance_payment": {
"type": "object",
"description": "Advanced Amount Paid of sales Delivery",
"readOnly": false,
"properties": {
"amount": {
"type": "number",
"description": "amount payed in advance",
"readOnly": false
},
"date": {
"type": "string",
"format": "date-time",
"description": "date of the payment",
"readOnly": false
},
"payment_method_id": {
"type": "string",
"description": "Payment method",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"price_type_id": {
"type": "string",
"description": "Type price id",
"x-sage-entitylink": "item_type_prices",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"charges_total": {
"type": "number",
"description": "Amount charges of sales Delivery",
"readOnly": false
},
"commission_amount": {
"type": "number",
"description": "Amount Commission of sales Delivery",
"readOnly": false
},
"discount_amount": {
"type": "number",
"description": "Amount discount of sale Delivery",
"readOnly": false
},
"discount_payment_method_amount": {
"type": "number",
"description": "Amount discount payment method of sales Delivery",
"readOnly": false
},
"discount_amount_rappel_amount": {
"type": "number",
"description": "Discount Rappel Amount of sale Delivery",
"readOnly": false
},
"net_total": {
"type": "number",
"description": "SubTotal of sale Delivery",
"readOnly": false
},
"tax_total": {
"type": "number",
"description": "Total Tax of sales Delivery",
"readOnly": false
},
"income_tax_amount": {
"type": "number",
"description": "Tax INCOME_TAX of sales Delivery",
"readOnly": false
},
"total": {
"type": "number",
"description": "Total of sale Delivery",
"readOnly": false
},
"notes": {
"type": "string",
"description": "Notes",
"readOnly": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false
}
}
}
},
"sales_delivery_lines": {
"type": "array",
"description": "List of sales delivery lines",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID delivery line of sales Delivery lines",
"readOnly": false
},
"sales_order_lines_id": {
"type": "string",
"description": "Sales order lines ID relation Order",
"x-sage-entitylink": "sales_order_lines",
"readOnly": false
},
"order": {
"type": "integer",
"format": "int32",
"description": "Presentation order",
"readOnly": false
},
"item_set_id": {
"type": "string",
"description": "Set id",
"x-sage-entitylink": "item_sets",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_id": {
"type": "string",
"description": "ID Items of sales Delivery lines",
"x-sage-entitylink": "items",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_barcode": {
"type": "string",
"description": "Items BarCode of sales Delivery lines",
"readOnly": false
},
"item_description": {
"type": "string",
"description": "Items Description of sales Delivery lines",
"readOnly": false
},
"item_long_description": {
"type": "string",
"description": "Items Long desription of sales Delivery lines",
"readOnly": false
},
"properties": {
"type": "array",
"description": "Property value list of sales Delivery lines",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"item_property_id": {
"type": "string",
"maxLength": 5,
"description": "Property id",
"x-sage-entitylink": "item_properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"maxLength": 20,
"description": "Value",
"readOnly": false
},
"group": {
"type": "string",
"description": "Group of the Property",
"readOnly": false
}
}
}
},
"vat_tax_rate": {
"type": "number",
"description": "Percent tax of sales Delivery lines",
"readOnly": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax Surcharge of Tax table",
"readOnly": false
},
"quantity": {
"type": "number",
"description": "Quantity of sales Delivery lines",
"readOnly": false
},
"price": {
"type": "number",
"description": "Sales price of sales Delivery lines",
"readOnly": false
},
"item_discount_percent": {
"type": "number",
"description": "Percent discount of sales Delivery lines",
"readOnly": false
},
"commission_percent": {
"type": "number",
"description": "Percent Commission of sales Delivery lines",
"readOnly": false
},
"line_included_vat": {
"type": "boolean",
"description": "Lines Included VAT of sales delivery lines",
"readOnly": false
},
"location_id": {
"type": "string",
"description": "ID Location of the sales delivery lines",
"x-sage-entitylink": "locations",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_line_amount": {
"type": "number",
"description": "Discount line of sales Delivery lines",
"readOnly": false
},
"net_total": {
"type": "number",
"description": "Net total of the line",
"readOnly": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax amount of sales Delivery lines",
"readOnly": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of Tax table",
"readOnly": false
},
"total": {
"type": "number",
"description": "Lines amount of sales delivery lines",
"readOnly": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false
}
}
}
}
}
}
},
"sales_delivery_taxes": {
"type": "array",
"description": "List of sales delivery taxes",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of Sales Delivery taxes",
"readOnly": 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 Sales delivery taxes",
"readOnly": false
},
"vat_tax_rate": {
"type": "number",
"description": "Tax VAT of Sales Delivery taxes",
"readOnly": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax Amount VAT of Sales Delivery taxes",
"readOnly": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax VAT_surcharge of Sales Delivery taxes",
"readOnly": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of Sales Delivery taxes",
"readOnly": false
},
"total_tax_amount": {
"type": "number",
"description": "Total taxes",
"readOnly": false
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the sales delivery",
"readOnly": false
}
}
}Response 201
OK. Resource created.
{
"id": "string",
"company_id": "string",
"period": "string",
"serial": "string",
"number": 0,
"date": "string",
"delivery_date": "string",
"customer_id": "string",
"status": "1",
"currency": "string",
"currency_change_rate": 0.0,
"tax_type": "1",
"included_vat": true,
"address_id": "string",
"delivery_address_id": "string",
"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_delivery_number": "string",
"advance_payment": {
"amount": 0.0,
"date": "string",
"payment_method_id": "string"
},
"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,
"net_total": 0.0,
"tax_total": 0.0,
"income_tax_amount": 0.0,
"total": 0.0,
"notes": "string",
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"sales_delivery_lines": [
{
"id": "string",
"sales_order_lines_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_line_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_delivery_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
}
],
"timestamp": "string"
}{
"type": "object",
"description": "List of sales deliveries of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Deliveries",
"x-sage-relatedopeations": [
"companies",
"customers",
"contacts",
"item_type_prices",
"payment_methods",
"zones",
"sales_persons",
"cost_centers",
"customer_groups",
"income_tax_rates"
],
"required": [
"company_id",
"customer_id"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the sales Delivery",
"readOnly": false
},
"company_id": {
"type": "string",
"description": "Company ID of sales Delivery",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"period": {
"type": "string",
"description": "Period Sales delivery of sales Delivery",
"readOnly": false
},
"serial": {
"type": "string",
"description": "Serial of sales Delivery",
"readOnly": false
},
"number": {
"type": "integer",
"format": "int64",
"description": "Number of sales Delivery",
"readOnly": false
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of sales Delivery",
"readOnly": false
},
"delivery_date": {
"type": "string",
"format": "date-time",
"description": "Delivery date of sales Delivery",
"readOnly": false
},
"customer_id": {
"type": "string",
"description": "Id Customer of sales Delivery",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"status": {
"type": "string",
"description": "Status of the document. See <a href=\"/docs#/spain/facturaplus/sales/v1/documentstatustype\">documentstatustype</a>",
"readOnly": false,
"x-sage-enumlink": "documentstatustype",
"enum": [
"1",
"2"
]
},
"currency": {
"type": "string",
"description": "Currency of sales Delivery",
"readOnly": false
},
"currency_change_rate": {
"type": "number",
"description": "Currency Change Rate of sales Delivery",
"readOnly": false
},
"tax_type": {
"type": "string",
"description": "Tax reference of sales Delivery. See <a href=\"/docs#/spain/facturaplus/sales/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
]
},
"included_vat": {
"type": "boolean",
"description": "Include VAT of sales Delivery",
"readOnly": false
},
"address_id": {
"type": "string",
"description": "Id Address of sales Delivery",
"x-sage-entitylink": "addresses",
"readOnly": false
},
"delivery_address_id": {
"type": "string",
"description": "Id Delivery Address of sales Delivery",
"x-sage-entitylink": "addresses",
"readOnly": false
},
"payment_method_id": {
"type": "string",
"description": "Id paymentmethod of sale Delivery",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_person_id": {
"type": "string",
"description": "Id Sales persons of sales Delivery",
"x-sage-entitylink": "sales_persons",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"commission_percent": {
"type": "number",
"description": "Commission Percent of sales Delivery",
"readOnly": false
},
"discount_percent": {
"type": "number",
"description": "Percent discount of sales Delivery",
"readOnly": false
},
"discount_payment_method_percent": {
"type": "number",
"description": "Percent discount of sales Delivery",
"readOnly": false
},
"discount_amount_rappel_percent": {
"type": "number",
"description": "Percent Discount Amount Rappel of sales Delivery",
"readOnly": false
},
"income_tax_rate_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 sale Delivery",
"readOnly": false
},
"your_sales_delivery_number": {
"type": "string",
"description": "Your order of sales Delivery",
"readOnly": false
},
"advance_payment": {
"type": "object",
"description": "Advanced Amount Paid of sales Delivery",
"readOnly": false,
"properties": {
"amount": {
"type": "number",
"description": "amount payed in advance",
"readOnly": false
},
"date": {
"type": "string",
"format": "date-time",
"description": "date of the payment",
"readOnly": false
},
"payment_method_id": {
"type": "string",
"description": "Payment method",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"price_type_id": {
"type": "string",
"description": "Type price id",
"x-sage-entitylink": "item_type_prices",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"charges_total": {
"type": "number",
"description": "Amount charges of sales Delivery",
"readOnly": false
},
"commission_amount": {
"type": "number",
"description": "Amount Commission of sales Delivery",
"readOnly": false
},
"discount_amount": {
"type": "number",
"description": "Amount discount of sale Delivery",
"readOnly": false
},
"discount_payment_method_amount": {
"type": "number",
"description": "Amount discount payment method of sales Delivery",
"readOnly": false
},
"discount_amount_rappel_amount": {
"type": "number",
"description": "Discount Rappel Amount of sale Delivery",
"readOnly": false
},
"net_total": {
"type": "number",
"description": "SubTotal of sale Delivery",
"readOnly": false
},
"tax_total": {
"type": "number",
"description": "Total Tax of sales Delivery",
"readOnly": false
},
"income_tax_amount": {
"type": "number",
"description": "Tax INCOME_TAX of sales Delivery",
"readOnly": false
},
"total": {
"type": "number",
"description": "Total of sale Delivery",
"readOnly": false
},
"notes": {
"type": "string",
"description": "Notes",
"readOnly": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false
}
}
}
},
"sales_delivery_lines": {
"type": "array",
"description": "List of sales delivery lines",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID delivery line of sales Delivery lines",
"readOnly": false
},
"sales_order_lines_id": {
"type": "string",
"description": "Sales order lines ID relation Order",
"x-sage-entitylink": "sales_order_lines",
"readOnly": false
},
"order": {
"type": "integer",
"format": "int32",
"description": "Presentation order",
"readOnly": false
},
"item_set_id": {
"type": "string",
"description": "Set id",
"x-sage-entitylink": "item_sets",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_id": {
"type": "string",
"description": "ID Items of sales Delivery lines",
"x-sage-entitylink": "items",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_barcode": {
"type": "string",
"description": "Items BarCode of sales Delivery lines",
"readOnly": false
},
"item_description": {
"type": "string",
"description": "Items Description of sales Delivery lines",
"readOnly": false
},
"item_long_description": {
"type": "string",
"description": "Items Long desription of sales Delivery lines",
"readOnly": false
},
"properties": {
"type": "array",
"description": "Property value list of sales Delivery lines",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"item_property_id": {
"type": "string",
"maxLength": 5,
"description": "Property id",
"x-sage-entitylink": "item_properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"maxLength": 20,
"description": "Value",
"readOnly": false
},
"group": {
"type": "string",
"description": "Group of the Property",
"readOnly": false
}
}
}
},
"vat_tax_rate": {
"type": "number",
"description": "Percent tax of sales Delivery lines",
"readOnly": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax Surcharge of Tax table",
"readOnly": false
},
"quantity": {
"type": "number",
"description": "Quantity of sales Delivery lines",
"readOnly": false
},
"price": {
"type": "number",
"description": "Sales price of sales Delivery lines",
"readOnly": false
},
"item_discount_percent": {
"type": "number",
"description": "Percent discount of sales Delivery lines",
"readOnly": false
},
"commission_percent": {
"type": "number",
"description": "Percent Commission of sales Delivery lines",
"readOnly": false
},
"line_included_vat": {
"type": "boolean",
"description": "Lines Included VAT of sales delivery lines",
"readOnly": false
},
"location_id": {
"type": "string",
"description": "ID Location of the sales delivery lines",
"x-sage-entitylink": "locations",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_line_amount": {
"type": "number",
"description": "Discount line of sales Delivery lines",
"readOnly": false
},
"net_total": {
"type": "number",
"description": "Net total of the line",
"readOnly": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax amount of sales Delivery lines",
"readOnly": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of Tax table",
"readOnly": false
},
"total": {
"type": "number",
"description": "Lines amount of sales delivery lines",
"readOnly": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false
}
}
}
}
}
}
},
"sales_delivery_taxes": {
"type": "array",
"description": "List of sales delivery taxes",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of Sales Delivery taxes",
"readOnly": 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 Sales delivery taxes",
"readOnly": false
},
"vat_tax_rate": {
"type": "number",
"description": "Tax VAT of Sales Delivery taxes",
"readOnly": false
},
"vat_tax_amount": {
"type": "number",
"description": "Tax Amount VAT of Sales Delivery taxes",
"readOnly": false
},
"surcharge_tax_rate": {
"type": "number",
"description": "Tax VAT_surcharge of Sales Delivery taxes",
"readOnly": false
},
"surcharge_tax_amount": {
"type": "number",
"description": "Tax Amount VAT_surcharge of Sales Delivery taxes",
"readOnly": false
},
"total_tax_amount": {
"type": "number",
"description": "Total taxes",
"readOnly": false
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the sales delivery",
"readOnly": false
}
}
}Code samples
@ECHO OFF
curl -v -X POST "https://api.columbus.sage.com/es/facturaplus/sales/v1/sales_deliveries"
-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/facturaplus/sales/v1/sales_deliveries?" + 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/facturaplus/sales/v1/sales_deliveries");
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/facturaplus/sales/v1/sales_deliveries?" + $.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/facturaplus/sales/v1/sales_deliveries";
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/facturaplus/sales/v1/sales_deliveries');
$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/facturaplus/sales/v1/sales_deliveries?%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/facturaplus/sales/v1/sales_deliveries?%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/facturaplus/sales/v1/sales_deliveries')
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