• id

  integer

  Internal identifier of sale.

  {"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of sale.","example":null,"required":false,"children":[]}

• type

  integer

  Type of sale:
  -1 - Order,
  0 - Invoice,
  1 - Invoice correction,
  2 - Receipt,
  3 - Receipt correction,
  5 - Advance invoice,
  10 - Utilization,
  100 - Invoice non-rating,
  101 - Temporary invoice

  {"name":"type","propertyName":"type","type":{"format":null},"description":"Type of sale:\r\n-1 - Order,\r\n0 - Invoice,\r\n1 - Invoice correction,\r\n2 - Receipt,\r\n3 - Receipt correction,\r\n5 - Advance invoice,\r\n10 - Utilization,\r\n100 - Invoice non-rating,\r\n101 - Temporary invoice","example":null,"required":false,"children":[]}

• created

  datetime (YYYY-MM-DD HH:MM:SS)

  When sale was created

  {"name":"created","propertyName":"created","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When sale was created","example":null,"required":false,"children":[]}

• datecancel

  datetime (YYYY-MM-DD HH:MM:SS)

  When sale was cancelled

  {"name":"datecancel","propertyName":"dateCancel","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When sale was cancelled","example":null,"required":false,"children":[]}

• modified

  datetime (YYYY-MM-DD HH:MM:SS)

  When sale was last modified

  {"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When sale was last modified","example":null,"required":false,"children":[]}

• invoicename

  string

  Name of assigned financial document

  {"name":"invoicename","propertyName":"invoiceName","type":{"format":null},"description":"Name of assigned financial document","example":null,"required":false,"children":[]}

• ordername

  string

  Name of sale

  {"name":"ordername","propertyName":"orderName","type":{"format":null},"description":"Name of sale","example":null,"required":false,"children":[]}

• fksale

  integer

  Internal ID of corrected sale

  {"name":"fksale","propertyName":"fkSale","type":{"format":null},"description":"Internal ID of corrected sale","example":null,"required":false,"children":[]}

• correctedname

  string

  Name of sale that is being corrected by that sale

  {"name":"correctedname","propertyName":"correctedName","type":{"format":null},"description":"Name of sale that is being corrected by that sale","example":null,"required":false,"children":[]}

• fksalenonrating

  integer

  Internal ID of non rating sale

  {"name":"fksalenonrating","propertyName":"fkSaleNonRating","type":{"format":null},"description":"Internal ID of non rating sale","example":null,"required":false,"children":[]}

• nonratingname

  string

  Name of sale that is marked as a non rating one

  {"name":"nonratingname","propertyName":"nonRatingName","type":{"format":null},"description":"Name of sale that is marked as a non rating one","example":null,"required":false,"children":[]}

• correctionname

  string

  Name of sale that is correcting this sale

  {"name":"correctionname","propertyName":"correctionName","type":{"format":null},"description":"Name of sale that is correcting this sale","example":null,"required":false,"children":[]}

• symbol

  string

  Sale's currency symbol

  Example: Three letters format ie: PLN, EUR, USD.

  {"name":"symbol","propertyName":"symbol","type":{"format":null},"description":"Sale's currency symbol","example":"Three letters format ie: PLN, EUR, USD.","required":false,"children":[]}

• fkcurrency

  integer

  Internal ID of used currency

  {"name":"fkcurrency","propertyName":"fkCurrency","type":{"format":null},"description":"Internal ID of used currency","example":null,"required":false,"children":[]}

• shipmenttypeid

  integer

  Shipment type internal identifier

  {"name":"shipmenttypeid","propertyName":"shipmentTypeId","type":{"format":null},"description":"Shipment type internal identifier","example":null,"required":false,"children":[]}

• shipmenttypename

  string

  Shipment type name

  {"name":"shipmenttypename","propertyName":"shipmentTypeName","type":{"format":null},"description":"Shipment type name","example":null,"required":false,"children":[]}

• pickuppointid

  integer

  Pickup point ID for selected provider

  {"name":"pickuppointid","propertyName":"pickupPointId","type":{"format":null},"description":"Pickup point ID for selected provider","example":null,"required":false,"children":[]}

• paymenttypeid

  integer

  Payment type internal identifier

  {"name":"paymenttypeid","propertyName":"paymentTypeId","type":{"format":null},"description":"Payment type internal identifier","example":null,"required":false,"children":[]}

• paymenttypename

  string

  Payment type name

  {"name":"paymenttypename","propertyName":"paymentTypeName","type":{"format":null},"description":"Payment type name","example":null,"required":false,"children":[]}

• paymentdescription

  string

  Payment type description

  {"name":"paymentdescription","propertyName":"paymentDescription","type":{"format":null},"description":"Payment type description","example":null,"required":false,"children":[]}

• paymenttag

  string

  Internal tag of payment type

  {"name":"paymenttag","propertyName":"paymentTag","type":{"format":null},"description":"Internal tag of payment type","example":null,"required":false,"children":[]}

• receivername

  string

  Receiver name

  {"name":"receivername","propertyName":"receiverName","type":{"format":null},"description":"Receiver name","example":null,"required":false,"children":[]}

• postalcode

  string

  Receiver postal code

  {"name":"postalcode","propertyName":"postalCode","type":{"format":null},"description":"Receiver postal code","example":null,"required":false,"children":[]}

• city

  string

  Receiver city

  {"name":"city","propertyName":"city","type":{"format":null},"description":"Receiver city","example":null,"required":false,"children":[]}

• street

  string

  Receiver street

  {"name":"street","propertyName":"street","type":{"format":null},"description":"Receiver street","example":null,"required":false,"children":[]}

• bno

  string

  Receiver building no.

  {"name":"bno","propertyName":"bno","type":{"format":null},"description":"Receiver building no.","example":null,"required":false,"children":[]}

• lno

  string

  Receiver locale no.

  {"name":"lno","propertyName":"lno","type":{"format":null},"description":"Receiver locale no.","example":null,"required":false,"children":[]}

• fkcountry

  integer

  Receiver country internal ID

  {"name":"fkcountry","propertyName":"fkCountry","type":{"format":null},"description":"Receiver country internal ID","example":null,"required":false,"children":[]}

• countryname

  string

  Receiver country name

  {"name":"countryname","propertyName":"countryName","type":{"format":null},"description":"Receiver country name","example":null,"required":false,"children":[]}

• iso

  string

  Receiver country ISO code

  Example: Two letters format ie: DE, PL, GB, US

  {"name":"iso","propertyName":"iso","type":{"format":null},"description":"Receiver country ISO code","example":"Two letters format ie: DE, PL, GB, US","required":false,"children":[]}

• phone

  string

  Receiver phone no.

  {"name":"phone","propertyName":"phone","type":{"format":null},"description":"Receiver phone no.","example":null,"required":false,"children":[]}

• email

  string

  Receiver email address

  {"name":"email","propertyName":"email","type":{"format":null},"description":"Receiver email address","example":null,"required":false,"children":[]}

• weight

  float

  Total net weight of sale's products

  {"name":"weight","propertyName":"weight","type":{"format":null},"description":"Total net weight of sale's products","example":null,"required":false,"children":[]}

• weightgross

  float

  Total gross weight of sale's products

  {"name":"weightgross","propertyName":"weightGross","type":{"format":null},"description":"Total gross weight of sale's products","example":null,"required":false,"children":[]}

• notice

  string

  Sale's notice

  {"name":"notice","propertyName":"notice","type":{"format":null},"description":"Sale's notice","example":null,"required":false,"children":[]}

• paydays

  integer

  Days until sale will be cancelled if not payed

  {"name":"paydays","propertyName":"payDays","type":{"format":null},"description":"Days until sale will be cancelled if not payed","example":null,"required":false,"children":[]}

• fkcontractor

  integer

  Buyer's internal ID

  {"name":"fkcontractor","propertyName":"fkContractor","type":{"format":null},"description":"Buyer's internal ID","example":null,"required":false,"children":[]}

• contractorname

  string

  Buyer (invoice) full name (or company name)

  {"name":"contractorname","propertyName":"contractorName","type":{"format":null},"description":"Buyer (invoice) full name (or company name)","example":null,"required":false,"children":[]}

• contractorpostalcode

  string

  Buyer (invoice) postal code

  {"name":"contractorpostalcode","propertyName":"contractorPostalCode","type":{"format":null},"description":"Buyer (invoice) postal code","example":null,"required":false,"children":[]}

• contractorcity

  string

  Buyer (invoice) city

  {"name":"contractorcity","propertyName":"contractorCity","type":{"format":null},"description":"Buyer (invoice) city","example":null,"required":false,"children":[]}

• contractorstreet

  string

  Buyer (invoice) street

  {"name":"contractorstreet","propertyName":"contractorStreet","type":{"format":null},"description":"Buyer (invoice) street","example":null,"required":false,"children":[]}

• contractorbuildingno

  string

  Buyer (invoice) building no.

  {"name":"contractorbuildingno","propertyName":"contractorBuildingNo","type":{"format":null},"description":"Buyer (invoice) building no.","example":null,"required":false,"children":[]}

• contractorflatno

  string

  Buyer (invoice) locale no.

  {"name":"contractorflatno","propertyName":"contractorFlatNo","type":{"format":null},"description":"Buyer (invoice) locale no.","example":null,"required":false,"children":[]}

• contractorfkcountry

  integer

  Buyer (invoice) country internal ID

  {"name":"contractorfkcountry","propertyName":"contractorFkCountry","type":{"format":null},"description":"Buyer (invoice) country internal ID","example":null,"required":false,"children":[]}

• contractorcountryname

  string

  Buyer (invoice) country name

  {"name":"contractorcountryname","propertyName":"contractorCountryName","type":{"format":null},"description":"Buyer (invoice) country name","example":null,"required":false,"children":[]}

• contractorcountryiso

  string

  Buyer (invoice) country ISO code

  Example: Two letters format ie: DE, PL, GB, US

  {"name":"contractorcountryiso","propertyName":"contractorCountryIso","type":{"format":null},"description":"Buyer (invoice) country ISO code","example":"Two letters format ie: DE, PL, GB, US","required":false,"children":[]}

• paid

  float

  Value paid

  {"name":"paid","propertyName":"paid","type":{"format":null},"description":"Value paid","example":null,"required":false,"children":[]}

• paymentdeadline

  datetime (YYYY-MM-DD HH:MM:SS)

  Payment deadline

  {"name":"paymentdeadline","propertyName":"paymentDeadline","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Payment deadline","example":null,"required":false,"children":[]}

• isassembling

  boolean (1 = true, 0 = false)

  Points whether sale is marked as still assembling

  {"name":"isassembling","propertyName":"isAssembling","type":{"format":"1 = true, 0 = false"},"description":"Points whether sale is marked as still assembling","example":null,"required":false,"children":[]}

• ispaid

  boolean (1 = true, 0 = false)

  Points whether sale is fully paid

  {"name":"ispaid","propertyName":"isPaid","type":{"format":"1 = true, 0 = false"},"description":"Points whether sale is fully paid","example":null,"required":false,"children":[]}

• ispacked

  boolean (1 = true, 0 = false)

  Points whether sale is already packed

  {"name":"ispacked","propertyName":"isPacked","type":{"format":"1 = true, 0 = false"},"description":"Points whether sale is already packed","example":null,"required":false,"children":[]}

• isshipped

  boolean (1 = true, 0 = false)

  Points whether sale is shipped

  {"name":"isshipped","propertyName":"isShipped","type":{"format":"1 = true, 0 = false"},"description":"Points whether sale is shipped","example":null,"required":false,"children":[]}

• mergedids

  string

  Lists of sales IDs that were merged into this one, comma separated string

  {"name":"mergedids","propertyName":"mergedIds","type":{"format":null},"description":"Lists of sales IDs that were merged into this one, comma separated string","example":null,"required":false,"children":[]}

• leadtime

  integer

  Processing time in days since order was placed

  {"name":"leadtime","propertyName":"leadTime","type":{"format":null},"description":"Processing time in days since order was placed","example":null,"required":false,"children":[]}

• productprice

  float

  Total net price of sale's products

  {"name":"productprice","propertyName":"productPrice","type":{"format":null},"description":"Total net price of sale's products","example":null,"required":false,"children":[]}

• productpricegross

  float

  Total gross price of sale's products

  {"name":"productpricegross","propertyName":"productPriceGross","type":{"format":null},"description":"Total gross price of sale's products","example":null,"required":false,"children":[]}

• packageprice

  float

  Net price for packaging

  {"name":"packageprice","propertyName":"packagePrice","type":{"format":null},"description":"Net price for packaging","example":null,"required":false,"children":[]}

• packagepricegross

  float

  Gross price for packaging

  {"name":"packagepricegross","propertyName":"packagePriceGross","type":{"format":null},"description":"Gross price for packaging","example":null,"required":false,"children":[]}

• paymentprice

  float

  Net price of sale's payment method

  {"name":"paymentprice","propertyName":"paymentPrice","type":{"format":null},"description":"Net price of sale's payment method","example":null,"required":false,"children":[]}

• paymentpricegross

  float

  Gross price of sale's payment method

  {"name":"paymentpricegross","propertyName":"paymentPriceGross","type":{"format":null},"description":"Gross price of sale's payment method","example":null,"required":false,"children":[]}

• shipmentprice

  float

  Net price of sale's shipment method

  {"name":"shipmentprice","propertyName":"shipmentPrice","type":{"format":null},"description":"Net price of sale's shipment method","example":null,"required":false,"children":[]}

• shipmentpricegross

  float

  Gross price of sale's shipment method

  {"name":"shipmentpricegross","propertyName":"shipmentPriceGross","type":{"format":null},"description":"Gross price of sale's shipment method","example":null,"required":false,"children":[]}

• total

  float

  Total net price of sale's previous prices

  {"name":"total","propertyName":"total","type":{"format":null},"description":"Total net price of sale's previous prices","example":null,"required":false,"children":[]}

• totalgross

  float

  Total gross price of sale's previous prices

  {"name":"totalgross","propertyName":"totalGross","type":{"format":null},"description":"Total gross price of sale's previous prices","example":null,"required":false,"children":[]}

Example URL: https://magboss.pl/api/getSale.json?key=YOURAPIKEY&lang=en&id=112087

Example URL: https://magboss.pl/api/getSale.xml?key=YOURAPIKEY&lang=en&id=112087