Invoiceable Docs

Appearance

Overview ​

RecipientData is a data structure used within the Invoicing API.

Definition ​

typescript
export type RecipientData = {
        name: string;
        contact_person: string | null;
        street: string;
        zip: string;
        city: string;
        country_code: string;
        email: string | null;
        phone: string | null;
        vat_id: string | null;
        gln: string | null;
        leitweg_id: string | null;
        electronic_address: string | null;
        electronic_address_scheme: string | null;
        legal_registration_id: string | null;
        legal_registration_scheme: string | null;
        trading_name: string | null;
    };

Properties ​

Required Fields ​

name ​

  • Type: string
  • Description: Company or person name. [BT-153]

street ​

  • Type: string
  • Description: Street address. [BT-35 (Seller) / BT-50 (Buyer)]

zip ​

  • Type: string
  • Description: Postal code. [BT-38 (Seller) / BT-53 (Buyer)]

city ​

  • Type: string
  • Description: City. [BT-37 (Seller) / BT-52 (Buyer)]

country_code ​

  • Type: string
  • Description: ISO 3166-1 alpha-2 country code. [BT-40 (Seller) / BT-55 (Buyer)]

Optional Fields ​

contact_person ​

  • Type: string | null
  • Description: Name of contact person.

email ​

  • Type: string | null
  • Description: Email address.

phone ​

  • Type: string | null
  • Description: Phone number.

vat_id ​

  • Type: string | null
  • Description: VAT Identification Number. [BT-31 (Seller) / BT-48 (Buyer)]

gln ​

  • Type: string | null
  • Description: No description available.

leitweg_id ​

  • Type: string | null
  • Description: No description available.

electronic_address ​

  • Type: string | null
  • Description: No description available. [BT-34 (Seller) / BT-49 (Buyer)]

electronic_address_scheme ​

  • Type: string | null
  • Description: No description available.
  • Type: string | null
  • Description: No description available.
  • Type: string | null
  • Description: No description available.

trading_name ​

  • Type: string | null
  • Description: No description available. [BT-28]

Usage ​

This type is used in the following structures: