Hdr Class - Properties

<< Klicke um Table of Contents anzuzeigen  >>

Navigation:  Nexus Interfacebook EN > Importinterfaces > NREI (JSON) > NREI Classes >

Hdr Class - Properties

This chapter describes all Properties of the class Hdr.

It portrays the head-data of the invoice (i.e. address, date, invoice number, total of the invoice etc.)

The name, the description and the data-type of the property will be listed, as well as the information whether the field can be transferred or not.

Name

Description

Data type

Optional / Mandatory-Field

APmtA

AdditionalPaymentAmount – amount of payment method surcharge

Decimal

OPTIONAL

APmtAEUR

AdditionalPaymentAmount – amount of payment method surcharge in EURO. This field doesn’t have to be specified if the invoice is in EURO.

Decimal

OPTIONAL

C

Country – Invoice-receiving country. Country-code ISO-3166

String

MANDATORY

CA

CouponAmount – payment amount, if paid with credit voucher. Only if the invoice is gross, has a negative leading sign and the voucher amount is not issued as an invoice-position.

Decimal

OPTIONAL

CAEUR

CouponAmount – payment amount, if paid with credit voucher in EURO. Only if the invoice is gross, has a negative leading sign and the voucher amount is not issued as an invoice-position. The field is empty if the invoice is issued in EURO.

Decimal

OPTIONAL

CC

CurrencyCode – currency  in which the invoice was issued (ISO-4217)

String

MANDATORY

CGrp

CustomerGroup – group of customers

String

OPTIONAL

CID

CustomerID – delivers explicit ID, under which the customer is saved in the Shopsystem

String

MANDATORY

City

City – location of the invoice address

(MANDATORY for Invoices)

String

MANDATORY *

CN

CompanyName – name of the company.
(Either CompanyName or FamilyName is mandatory)

String

MANDATORY *

CNo

CustomerNo – customer number

String

OPTIONAL

CoDA

CashOnDeliveryAmount – fees for surname etc., gross in EURO. This field should only be used if the surname-fees can’t be transferred over in the form of an Invoice line item. For credits negative.

Decimal

OPTIONAL

CoDAEUR

CashOnDeliveryAmount – fees for surname etc., gross in EURO. This Field should only be used if the surname-fees can’t be handed over in the form of an Invoice-position. Field is empty if the invoice was issued in EURO. For credits negative.

Decimal

OPTIONAL

DL

DocumentLink – filename or link for dowloading the invoice-/voucher-PDF-document.

String

OPTIONAL

DlC

DeliveryCountry – supplying country if it differs from the invoice-receiving country  

String

MANDATORY

DlCt

DeliveryCity – destination of delivery

String

OPTIONAL

DlDt

DeliveryDate – date of delivery = date on which the whole order was delivered to the customer

(MANDATORY for Invoices)

DateTime

MANDATORY *

DlZ

DeliveryZip – postcode of the destination of the delivery

(MANDATORY for Invoices)

String

MANDATORY *

DN

DebtorNo – debtors-number. Is only needed if the debtors-number of the invoice will be used.

Int64

OPTIONAL

EbNm

EbayName

String

MANDATORY

EbPmtID

EbayPaymentID – payment-information, if the order was done through eBay.

String

MANDATORY

EM

Email – Email-address of the customer

String

MANDATORY

FamN

FamilyName – Surname of the customer
(Either CompanyName or FamilyName is mandatory)

String

MANDATORY *

FCExR

Exchange rate of foreign currency to EUR. Is only allowed to be stated if CC<>EUR. Rate is stated in form of 1 € = x foreign currency

Decimal

OPTIONAL

FN

FirstName – customer’s first name

(MANDATORY when using the amavat Module)

String

MANDATORY *

FS

FactoringStatus- 0=no factoring, 2=bought, 3=declined.  

Int32

OPTIONAL

GwA

GiftwrapAmount – Gift-wrap amount in invoice-currency

Decimal

OPTIONAL

GwAEUR

GiftwrapAmount – Gift-wrap amount in invoice-currency in EUR, if the invoice is not stated in EUR.

Decimal

OPTIONAL

IDt

InvoiceDate

DateTime

MANDATORY

INo

InvoiceNo – Invoice number

String

MANDATORY

IsNet

Netto Flag, has to be set to TRUE if the invoice was issued without sales tax, even though internally it was handled with sales tax. This Flag causes every following process to work with net values.

Boolean

MANDATORY

IsPf

IsProforma – TRUE if it is a proforma invoice?

Boolean

MANDATORY

IT

Inco-Term – international delivery conditions

(MANDATORY when using the Intrastat export)

String

MANDATORY *

KlnId

KlarnaPersonalId

String

OPTIONAL

ODt

Orderdate -  date of order

(MANDATORY for Invoices)

DateTime

MANDATORY *

OID

OrderID – OrderID - Unique ID under which all documents are led to a transaction (delivery notes, invoices, credits, etc.) if unclear which field must be used as order ID

String

MANDATORY

Pb

Postbox - Mailbox of invoice address

One of the Properties Pb or Str is mandatory

String

MANDATORY *

PL

PurchaseLink – seller auction link. Is needed to determine the sales channel, if it can’t be determined through ShopID/ShopName/SubShopID/SubShopName.

String

OPTIONAL

PmDt

PaymentDate

(MANDATORY for encashment orders, i.e. payment is before delivery; e.g. bank, PayPal, AmazonPay)

DateTime

MANDATORY *

PPEm

PayPalEmail

String

OPTIONAL

PrvINo

PreviousInvoiceNo – Delivers the invoice-/voucher number of the previous document i.e. current document is a credit-note, correcting an Invoice document is a voucher.

(MANDATORY if this voucher corrects a previous voucher)

String

MANDATORY *

PrVIDt

Previous Invoice Date – Delivers the invoice-/voucher Date of the previous document i.e. the   current document is a credit-note, correcting an Invoice document is a voucher.

(MANDATORY if this voucher corrects a previous voucher)

DateTime

MANDATORY *

PrvOID

PreviousOrderID – delivers thr Order-ID or rather invoice-number of the document to which the invoice belongs e.g. Order-ID to a vouchers invoice.

String

OPTIONAL

Rmrks

Remarks

String

OPTIONAL

ShA

ShippingAmount – shipping amount gross in EUR. This field is only needed if the shipping amount can’t be transferred over in the form of an invoice-position.

Decimal

OPTIONAL

ShAEUR

ShippingAmount – ShippingAmount gross in EURO. This field is only needed if the shipping amount can’t be transferred over in the form of an invoice-positon. This field is empty if the invoice was issued in EUR.

Decimal

OPTIONAL

ShDt

ShipmentDate

(MANDATORY for Invoices)

DateTime

MANDATORY *

ShGrp

ShippingGroup

String

OPTIONAL

SID

ShopID - Unique ID of the shop or platform the invoice was created from. Can be freely assigned.

String

MANDATORY

SN

ShopName – unique name/description of the shop or platform  the invoice was created from. Can be freely assigned.

String

OPTIONAL

SSID

SubShopID - provides unique ID of a shop-managed platform; Only relevant for multichannel systems: e.g. ShopID  1 = Plentymarkets, ShopID  1.1 = Amazon DE (connected to Plentymarkets)

String

OPTIONAL

SSINo

SubShopInvoiceNumber- external invoice number – returns invoice number if invoice was created by a managed platform e.g. the Amazon-invoice number, if the invoice was created by Amazon Business Services. The SSINo is never allowed to be handed over at the same time as the regular invoice number. (Exeption: Both fields hold the same value)

String

OPTIONAL

SSN

SubShopName – returns the unique name/description of the shop-managing platform

String

OPTIONAL

SSOID

SubShopOrderID - returns unique number under which the order is saved by the managing platform.

String

OPTIONAL

Str

Street- invoice address

One of the Properties Pb or Str is mandatory

String

MANDATORY *

TGrossA

TotalGrossAmount – total invoice amount (gross), including ALL invoice changing positions e.g. Shipping and CashOnDeliveryAmount

Decimal

MANDATORY

TGrossAEUR

TotalGrossAmount – total invoice amount (gross), including ALL invoice changing positions e.g. Shipping and CashOnDeliveryAmount in EUR if the order was issued in a foreign currency. If this field is empty the invoice was issued in EUR.

Decimal

OPTIONAL

TNetA

TotalNetAmount – total invoice amount from the net invoice positions, therefore without invoice changing positions (ShippingAmount etc.)

(MANDATORY for net invoices. If IsNet = true and TNetA <> TGrossA, then TNetA is used for further processing.)

Decimal

MANDATROY *

TNetAEUR

TotalNetAmountEUR – total invoice amount from the net invoice line item in EURO, therefore without invoice changing positions (ShippingAmount etc.) This field is empty if the invoice was issued in EURO.

Decimal

OPTIONAL

TNo

TrackingNumber – shipment number. Name of the shipper and the shipment number.
Multiple numbers have to be separated by commas.

String

OPTIONAL

TT

TransactionType – Is only to be filled if needed and if it is an invoice creating platform.
Field is currently not evaluated.

String

OPTIONAL

TVatA

TotalVATAmount – Total amount sales tax from the invoice positions, therefore without sales taxes from the invoice changing postions (shippingamount etc.)

Decimal

OPTIONAL

TVatAEUR

TotalNetAmountEUR – total invoice amount from the net invoice positions, therefore without invoice changing positions (ShippingAmount etc.) in EUR. This field is empty, if the invoice was issued in EURO.

Decimal

OPTIONAL

VatDp

VatDisplayed – flag whether sales taxes were issued.
FALSE, if the invoice includes sales taxes, but these have not been issued/printed.

Boolean

MANDATORY

VatID

VATID – sales tax-identification-number of the invoice receiver.

(MANDATORY, when customer is an enterprise with residence in the EU)

String

MANDATORY *

Zip

Zip – postal code of the invoice address

(MANDATORY for Invoices)

String

MANDATORY *


web_zoom18

You would like to know more about dekodi? Please visit our Website!

 

phone_zoom18

Or call us:  +49 911 310 429 - 10

 

mail_zoom18

Alternatively you can send an email to: info@dekodi.de

 

Impressum