Documentation

ManualOrderUploadHeaderPropertyNameConverter

in package

• Application

Table of Contents

Constants

HEADER_COMMENTS  = ['default' => ['type' => 'Type "sale" in lower-case' . PHP_EOL . 'Type "refund" in lower-case' . PHP_EOL . 'Type "expense" in lower-case', 'digital_service' => 'Insert "yes" if you are selling digital services and "no" if you are selling physical goods', 'deemed_supplier' => 'Add "YES" if the transactions are DEEMED.', 'importer' => 'Seller was acting as an importer in GB during the period of the transaction (YES, NO)', 'postponed_import_vat' => 'Enter "yes" if you are importing goods in Postponed VAT regime (VAT not paid on import)', 'channel_id' => 'Identifier of the sales channel: AMZ = Amazon; EBY = E-bay; WEB = Own Website or any other sales channel', 'invoice_number' => 'free text, number/name of invoice of transaction', 'transaction_id' => "it's numeric or alphanumeric unique code that distinguishs one transaction from another", 'vat_country' => '2 letter Country code of Country where VAT is paid. Please note that the Country code for UK is GB', 'invoice_date' => 'The date on which the payment was done,' . PHP_EOL . 'yyyy-mm-dd', 'payment_date' => 'Format should be YYYY-MM-DD. Date should be in the period you want to Report. For ex.: If you are reporting transactions in Oct 2021, date should be 2021-10-xx', 'shipping_date' => 'Format should be YYYY-MM-DD. Date should be in the period you want to Report. For ex.: If you are reporting transactions in Oct 2021, date should be 2021-10-xx', 'arrival_country' => '2 letter Country code of Country the goods are shipped to. Please note that the Country code for UK is GB', 'buyer_vat_number' => 'Two-letter country code followed with numerics without space or special character. Country must match', 'buyer_vat_number_country' => '2 letter Country code of Country where buyer is registered for VAT. Please note that the Country code for UK is GB', 'arrival_address' => 'the address of the receiver/buyer', 'arrival_city' => 'the city name where the goods are sent to', 'arrival_zip' => 'zip code of destination city', 'arrival_state' => 'the state name where the goods are sent to', 'departure_country' => '2 letter Country code of Country the goods are shipped from. Please note that the Country code for UK is GB', 'seller_vat_number' => 'supplier vat number, must be in accordance of departure country.', 'seller_vat_number_country' => '2 letter Country code of Country the goods are shipped from. Please note that the Country code for UK is GB', 'departure_address' => 'address of supplier', 'departure_city' => 'city name from where the goods are sent from', 'departure_zip' => 'zip code of departure city', 'departure_state' => 'state name from where the goods are sent from', 'buyer_billing_name' => 'Enter complete name of the customer', 'buyer_billing_country' => 'thecountry two-letter code for the person who is billed', 'buyer_billing_email' => 'buyer\'s email id', 'buyer_billing_address' => 'the address where the customer is billed from', 'buyer_billing_city' => 'the city where the customer who\'s billed is situated', 'buyer_billing_zip' => 'the zip code for city where the customer who\'s billed is situated', 'buyer_billing_state' => 'the state where the customer who\'s billed is situated', 'seller_billing_name' => 'name of seller that matches with the one given on invoice', 'seller_billing_country' => 'the country two-letter code where the seller is situated', 'seller_billing_email' => 'seller email ID', 'seller_billing_address' => 'address where the seller is situated', 'seller_billing_city' => 'the city where the seller is situated', 'seller_billing_zip' => 'the zip code of the city where the seller is situated', 'seller_billing_state' => 'the state where the seller is situated', 'hellotax_product_id' => 'internal code that hellotax assign to the products ', 'sku' => 'Product code or description free text, obligatory, only in case of selling physical goods.', 'quantity' => 'the quantity sold of each product', 'item_net_price' => 'the net price that is without any discounts, quantity and vat price', 'item_vat_price' => 'the vat price that is calculated on net price according to applicable vat rate on the invoice', 'item_vat_rate' => 'VAT Rate of the VAT Country i.e 19% should be written as 19', 'item_gross_unit_price' => 'Amount on which VAT is calculated. If you have an import and you know the VAT paid, but do not know the gross amount, please contact your Account Manager', 'item_shipping_price' => 'shipping cost of the items', 'item_discount' => 'discounts offered on any sales', 'item_shipping_discount' => 'discounts on shipping charges', 'product_net_value' => 'the actual amount the buyer needs to pay after any deductions or discounts', 'commodity_code' => 'a special code assigned to products to identify them when traded across borders', 'net_weight' => 'it\'s the weight of product excluding weight of packaging or additional material', 'original_currency' => 'Currency of the transaction']]

HEADER_HIGHLIGHTED_PROPERTIES  = ['movement' => ['type' => [], 'digital_service' => [], 'invoice_number' => [], 'vat_country' => [], 'payment_date' => [], 'arrival_country' => [], 'departure_country' => [], 'sku' => [], 'item_vat_rate' => [], 'product_net_value' => [], 'original_currency' => []], 'sales_refund' => ['type' => [], 'digital_service' => [], 'channel_id' => [], 'invoice_number' => [], 'vat_country' => [], 'payment_date' => [], 'shipping_date' => [], 'arrival_country' => [], 'buyer_vat_number' => [], 'buyer_vat_number_country' => [], 'departure_country' => [], 'buyer_billing_name' => [], 'sku' => [], 'item_vat_rate' => [], 'item_gross_unit_price' => [], 'original_currency' => []], 'expense' => ['type' => [], 'digital_service' => [], 'invoice_number' => [], 'vat_country' => [], 'payment_date' => [], 'arrival_country' => [], 'buyer_vat_number' => [], 'buyer_vat_number_country' => [], 'departure_country' => [], 'seller_vat_number' => [], 'seller_vat_number_country' => [], 'seller_billing_name' => [], 'sku' => [], 'item_vat_rate' => [], 'item_gross_unit_price' => [], 'original_currency' => []]]

HEADER_TO_DATABASE_FIELD_NAME_TRANSLATION  = [ 'TYPE' => 'type', 'DIGITAL SERVICE' => 'digital_service', 'DEEMED SUPPLIER' => 'deemed_supplier', 'IMPORTER' => 'importer', 'POSTPONED IMPORT VAT' => 'postponed_import_vat', 'CHANNEL ID' => 'channel_id', 'INVOICE NUMBER' => 'invoice_number', 'TRANSACTION ID' => 'transaction_id', 'VAT COUNTRY' => 'vat_country', 'PAYMENT DATE' => 'invoice_date', 'VAT REPORTING DATE' => 'payment_date', 'SHIPPING DATE' => 'shipping_date', 'ARRIVAL COUNTRY' => 'arrival_country', // to country 'BUYER VAT NUMBER' => 'buyer_vat_number', // buyer_vat_number -- to_country 'BUYER VAT NUMBER COUNTRY' => 'buyer_vat_number_country', 'ARRIVAL ADDRESS' => 'arrival_address', 'ARRIVAL CITY' => 'arrival_city', 'ARRIVAL ZIP' => 'arrival_zip', 'ARRIVAL STATE' => 'arrival_state', 'DEPARTURE COUNTRY' => 'departure_country', // from country 'SELLER VAT NUMBER' => 'seller_vat_number', // seller_vat_number -- from_country 'SELLER VAT NUMBER COUNTRY' => 'seller_vat_number_country', 'DEPARTURE ADDRESS' => 'departure_address', 'DEPARTURE CITY' => 'departure_city', 'DEPARTURE ZIP' => 'departure_zip', 'DEPARTURE STATE' => 'departure_state', 'BUYER BILLING NAME' => 'buyer_billing_name', "BUYER BILLING COUNTRY" => 'buyer_billing_country', 'BUYER BILLING EMAIL' => 'buyer_billing_email', 'BUYER BILLING ADDRESS' => 'buyer_billing_address', 'BUYER BILLING CITY' => 'buyer_billing_city', 'BUYER BILLING ZIP' => 'buyer_billing_zip', 'BUYER BILLING STATE' => 'buyer_billing_state', 'SELLER BILLING NAME' => 'seller_billing_name', 'SELLER BILLING COUNTRY' => 'seller_billing_country', 'SELLER BILLING EMAIL' => 'seller_billing_email', 'SELLER BILLING ADDRESS' => 'seller_billing_address', 'SELLER BILLING CITY' => 'seller_billing_city', 'SELLER BILLING ZIP' => 'seller_billing_zip', 'SELLER BILLING STATE' => 'seller_billing_state', 'HELLOTAX PRODUCT ID' => 'hellotax_product_id', 'SKU' => 'sku', 'QUANTITY' => 'quantity', 'ITEM NET PRICE' => 'item_net_price', 'ITEM VAT PRICE' => 'item_vat_price', 'ITEM VAT RATE' => 'item_vat_rate', 'ITEM GROSS UNIT PRICE' => 'item_gross_unit_price', 'ITEM SHIPPING PRICE' => 'item_shipping_price', 'ITEM DISCOUNT' => 'item_discount', 'ITEM SHIPPING DISCOUNT' => 'item_shipping_discount', 'PRODUCT NET PURCHASE VALUE' => 'product_net_value', 'COMMODITY CODE' => 'commodity_code', 'NET WEIGHT' => 'net_weight', 'ORIGINAL CURRENCY' => 'original_currency', ]

HEADER_TO_HEADER_TRANSLATION_ALIAS  = []

HEADER_TO_PROPERTY_TRANSLATION  = [ 'TYPE' => 'type', 'DIGITAL SERVICE' => 'digitalService', 'DEEMED SUPPLIER' => 'deemedSupplier', 'POSTPONED IMPORT VAT' => 'postponedImportVat', 'CHANNEL ID' => 'channelId', 'INVOICE NUMBER' => 'invoiceNumber', 'TRANSACTION ID' => 'transactionId', 'VAT COUNTRY' => 'vatCountry', 'PAYMENT DATE' => 'invoiceDate', 'VAT REPORTING DATE' => 'paymentDate', 'SHIPPING DATE' => 'shippingDate', 'ARRIVAL COUNTRY' => 'toCountry', // to country 'BUYER VAT NUMBER' => 'toVatNumber', // buyer_vat_number -- to_country 'BUYER VAT NUMBER COUNTRY' => 'toVatCountry', 'ARRIVAL ADDRESS' => 'toAddress', 'ARRIVAL CITY' => 'toCity', 'ARRIVAL ZIP' => 'toZip', 'ARRIVAL STATE' => 'toState', 'DEPARTURE COUNTRY' => 'fromCountry', // from country 'SELLER VAT NUMBER' => 'fromVatNumber', // seller_vat_number -- from_country 'SELLER VAT NUMBER COUNTRY' => 'fromVatCountry', 'DEPARTURE ADDRESS' => 'fromAddress', 'DEPARTURE CITY' => 'fromCity', 'DEPARTURE ZIP' => 'fromZip', 'DEPARTURE STATE' => 'fromState', 'BUYER BILLING NAME' => 'toBillingName', "BUYER BILLING COUNTRY" => 'toBillingCountry', 'BUYER BILLING EMAIL' => 'toBillingEmail', 'BUYER BILLING ADDRESS' => 'toBillingAddress', 'BUYER BILLING CITY' => 'toBillingCity', 'BUYER BILLING ZIP' => 'toBillingZip', 'BUYER BILLING STATE' => 'toBillingState', 'SELLER BILLING NAME' => 'fromBillingName', 'SELLER BILLING COUNTRY' => 'fromBillingCountry', 'SELLER BILLING EMAIL' => 'fromBillingEmail', 'SELLER BILLING ADDRESS' => 'fromBillingAddress', 'SELLER BILLING CITY' => 'fromBillingCity', 'SELLER BILLING ZIP' => 'fromBillingZip', 'SELLER BILLING STATE' => 'fromBillingState', 'HELLOTAX PRODUCT ID' => 'hellotaxProductId', 'SKU' => 'sku', 'QUANTITY' => 'quantity', 'ITEM NET PRICE' => 'itemNetPrice', 'ITEM VAT PRICE' => 'itemVatAmount', 'ITEM VAT RATE' => 'itemVatRate', 'ITEM GROSS UNIT PRICE' => 'itemGrossUnitPrice', 'ITEM SHIPPING PRICE' => 'shippingPrice', 'ITEM DISCOUNT' => 'discountAmount', 'ITEM SHIPPING DISCOUNT' => 'shippingDiscount', 'PRODUCT NET PURCHASE VALUE' => 'productNetValue', 'COMMODITY CODE' => 'commodityCode', 'NET WEIGHT' => 'weight', 'ORIGINAL CURRENCY' => 'originalCurrency', 'IMPORTER' => 'importer', ]

Methods

getAllAllowedFileHeaders()  : mixed

getComments()  : mixed

getHeaderAliasArray()  : mixed

getHeaderArray()  : mixed

getHeaderHighlightedPropertiesArray()  : mixed

getHeaderToDatabaseTableFieldNameTranslationArray()  : mixed

getHeaderToHeaderAliasTranslationArray()  : mixed

getHeaderToPropertyTranslationArray()  : mixed

getPropertyToHeaderTranslationArray()  : mixed

translateHeadersFromFileToDatabaseTableFieldNames()  : array<string|int, mixed>|null

translateHeadersToPropertyNames()  : array<string|int, mixed>|null

translatePropertyNameToFileHeader()  : mixed