getSale

Method returns sale details

Usage URL: https://e-hedo.pl/api/getSale.json?key=YOURAPIKEY

Query params

(put those in your URL, e.g. ?id=123)

  • id

    Internal identifier of sale. Only one ID

  • lang

    Language of result. ISO 2 Letter Language Codes ie: en, pl, cs

  • id | integer

    Internal identifier of sale.

  • 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

  • created | datetime

    When sale was created

  • datecancel | datetime

    When sale was cancelled

  • modified | datetime

    When sale was last modified

  • invoicename | string

    Name of assigned financial document

  • ordername | string

    Name of sale

  • fksale | integer

    Internal ID of corrected sale

  • correctedname | string

    Name of sale that is being corrected by that sale

  • fksalenonrating | integer

    Internal ID of non rating sale

  • nonratingname | string

    Name of sale that is marked as a non rating one

  • correctionname | string

    Name of sale that is correcting this sale

  • symbol | string

    Sale's currency symbol

  • fkcurrency | integer

    Internal ID of used currency

  • shipmenttypeid | integer

    Shipment type internal identifier

  • shipmenttypename | string

    Shipment type name

  • pickuppointid | integer

    Pickup point ID for selected provider

  • paymenttypeid | integer

    Payment type internal identifier

  • paymenttypename | string

    Payment type name

  • paymentdescription | string

    Payment type description

  • paymenttag | string

    Internal tag of payment type

  • receivername | string

    Sale's receiver name

  • postalcode | string

    Sale's receiver postal code

  • city | string

    Sale's receiver city

  • street | string

    Sale's receiver street

  • bno | string

    Sale's receiver building no.

  • lno | string

    Sale's receiver locale no.

  • fkcountry | integer

    Sale's receiver country internal ID

  • countryname | string

    Sale's receiver country name

  • iso | string

    Sale's receiver country ISO code

  • weight | float

    Total net weight of sale's products

  • weightgross | float

    Total gross weight of sale's products

  • notice | string

    Sale's notice

  • paydays | integer

    Days until sale will be cancelled if not payed

  • fkcontractor | integer

    Buyer's internal ID

  • contractorpostalcode | string

    Sale's buyer (invoice) postal code

  • contractorcity | string

    Sale's buyer (invoice) city

  • contractorstreet | string

    Sale's buyer (invoice) street

  • contractorbuildingno | string

    Sale's buyer (invoice) building no.

  • contractorflatno | string

    Sale's buyer (invoice) locale no.

  • contractorfkcountry | integer

    Sale's buyer (invoice) country internal ID

  • contractorcountryname | string

    Sale's buyer (invoice) country name

  • contractorcountryiso | string

    Sale's buyer (invoice) country ISO code

  • phone | string

    Sale's receiver phone no.

  • paid | float

    Value paid

  • paymentdeadline | datetime

    Payment deadline

  • ispaid | integer

    Points whether sale is fully paid

  • ispacked | integer

    Points whether sale is already packed

  • isshipped | integer

    Points whether sale is shipped

  • isassembling | integer

    Points whether sale is marked as still assembling

  • mergedids

    Lists of sales IDs that were merged into this one

  • packageprice | float

    Net price for packaging

  • packagepricegross | float

    Gross price for packaging

  • productprice | float

    Total net price of sale's products

  • productpricegross | float

    Total gross price of sale's products

  • paymentprice | float

    Net price of sale's payment method

  • paymentpricegross | float

    Gross price of sale's payment method

  • shipmentprice | float

    Net price of sale's shipment method

  • shipmentpricegross | float

    Gross price of sale's shipment method

  • total | float

    Total net price of sale's previous prices

  • totalgross | float

    Total gross price of sale's previous prices

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

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