Class Partner

Namespace

RetailForce.Fiscalisation.Model

Assembly

RetailForce.Fiscalisation.Model.dll

The partner for a document.

public class Partner

Inheritance

object

Partner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Possible examples for a document partner: Customer, Supplier, Store, ...

Constructors

Partner()

Initializes a new instance of the Partner class.

public Partner()

Partner(List<DocumentAddress>)

Initializes a new instance of the Partner class.

[JsonConstructor]
public Partner(List<DocumentAddress> Addresses)

Parameters

Addresses List<DocumentAddress>

The addresses.

Properties

AdditionalIdentifications

Additional identifications for the partner (additional to the id, for instance for loyalty systems).

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public Dictionary<string, string>? AdditionalIdentifications { get; set; }

Property Value

Dictionary<string, string>

AddressType

The address type.

public AddressType? AddressType { get; set; }

Property Value

AddressType?

Remarks

In several countries (for instance Canada / Quebec) you have to add address type.

Addresses

Gets or sets the addresses.

public List<DocumentAddress> Addresses { get; }

Property Value

List<DocumentAddress>

The addresses.

Caption

The caption (=name) of the partner.

public string Caption { get; set; }

Property Value

string

City

The city of the address.

[Required]
public string City { get; set; }

Property Value

string

Community

The community of the address.

public string? Community { get; set; }

Property Value

string

Remarks

In several countries (for instance Slovenia) you have to add the community to the address.

CompanyIdentification

Multiple company identifications for the partner.

public List<CompanyIdentification>? CompanyIdentification { get; set; }

Property Value

List<CompanyIdentification>

CountryCode

Countrycode according ISO 3166 alpha-3

[Required]
public string CountryCode { get; set; }

Property Value

string

FullStreet

returns the combination of street and street number

[JsonIgnore]
public string FullStreet { get; }

Property Value

string

Id

The id of the partner.

public string Id { get; set; }

Property Value

string

IdentificationType

The type of the identification shown in field PartnerIdentification.

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public PartnerIdentificationType? IdentificationType { get; set; }

Property Value

PartnerIdentificationType?

IsBusiness

True if the partner is business partner (B2B), if partner is consumer set to false (B2C).

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public bool? IsBusiness { get; set; }

Property Value

bool?

PartnerClassification

The classification of group or type of the partner (not the PartnerType).

public string PartnerClassification { get; set; }

Property Value

string

Remarks

This field can be used for subclassing customers (for instance). Therefore it can be used for customer groups, supplier groups etc.

PartnerIdentification

The identification of the partner. If set also the property IdentificationType must be set.

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string PartnerIdentification { get; set; }

Property Value

string

PartnerType

The type of this partner. For possible types see PartnerType.

public PartnerType PartnerType { get; set; }

Property Value

PartnerType

PostalCode

The postal code of the address.

[Required]
public string PostalCode { get; set; }

Property Value

string

Street

The street (without street number).

[Required]
public string Street { get; set; }

Property Value

string

StreetNumber

The street number (without street name).

[Required]
public string StreetNumber { get; set; }

Property Value

string

TaxNumber

The tax number of the partner.

public string TaxNumber { get; set; }

Property Value

string

VatNumber

The vat number of the partner.

public string VatNumber { get; set; }

Property Value

string

Remarks

This vat number is a valid EU-VAT number which can be validated through EU-VIES system.

Methods

GetDefaultAddress()

Gets the default address which is from inlined values

public DocumentAddress GetDefaultAddress()

Returns

DocumentAddress