# getExampleAdvice

Endpoint: GET /api/v1/examples/advice
Version: 1.1
Security: X-API-Key

## Query parameters:

  - `recipientEmail` (string, required)

## Response 200 fields (*/*):

  - `referenceNumber` (string, required)

  - `businessCaseDate` (string, required)

  - `totalAmount` (object, required)
    The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46).
Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.

  - `totalAmount.value` (number)
    - max. 99'999'999.99 for invoices, payments by instalments, reminders, credit notes and donation inquiries
- min. - 99'999'999.99, max 99'999'999.99 for advices
- Amount must be greater than 0 for invoices, payments by instalments, reminders and donation inquiries.
- Amount must be ≥ 0 for credit notes.
- If an IBAN or QR-IBAN is used for invoices or payments by instalments, the amount does not have to be supplied (compatibility QR invoice).

  - `totalAmount.currencyCode` (string, required)
    Currency code according to ISO 4217. When using QR-IBAN, only CHF and EUR are allowed.

  - `referencedBill` (object)

  - `billRecipient` (object, required)

  - `billRecipient.emailAddress` (string)

  - `billRecipient.enterpriseIdentificationNumber` (string)

  - `billRecipient.billRecipientSixId` (string)

  - `billRecipient.name` (string, required)

  - `billRecipient.address` (object, required)

  - `billRecipient.address.structuredAddress` (object)

  - `billRecipient.address.structuredAddress.street` (string)

  - `billRecipient.address.structuredAddress.buildingNumber` (string)

  - `billRecipient.address.structuredAddress.city` (string, required)

  - `billRecipient.address.structuredAddress.postalCode` (string, required)

  - `billRecipient.address.structuredAddress.countryCode` (string, required)
    Two-letter ISO country code according to ISO 3166-1.

  - `workflow` (object)
    Information about the workflow. Auxiliary data that can be used for pre-registering a business case in bill recipients ERP/bookkeeping.

  - `workflow.vatEnterpriseIdentificationNumbers` (object)
    Value Added Tax Enterprise Identification Numbers (VAT-UIDs) of the invoice issuer

  - `workflow.vatEnterpriseIdentificationNumbers.vatEnterpriseIdentificationNumber` (array)
    VAT-UID of the invoice issuer. Presentation without punctuation (e.g. CHE123456789MWST).

  - `workflow.deliveryDateStart` (string)
    Start date of the service provision, in case it is different than deliveryDateEnd

  - `workflow.deliveryDateEnd` (string)
    Delivery date or end date of the service provision

  - `workflow.netAmount` (object)
    Total invoice amount without VAT (e.g. CHF 1095.80)

  - `workflow.amountPaid` (object)
    Sum of the amount that was paid by the invoice recipient in advance (without VAT-relevant advance invoice). The outstanding total invoice amount to be paid corresponds to the element "totalAmount".

  - `workflow.vatRates` (object)
    Grouping of VAT rates

  - `workflow.vatRates.vatRate` (array, required)
    VAT information per VAT rate

  - `workflow.vatRates.vatRate.percentage` (number)
    VAT rate in percent (example: 8%)

  - `workflow.vatRates.vatRate.taxBaseAmount` (object)
    Tax base amount (example: CHF 1095.80)

  - `workflow.vatRates.vatRate.taxAmount` (object)
    Amount of a tax to be owed (example: CHF 87.66)

  - `workflow.caseReferenceForBillRecipient` (string)
    Association reference to be used by the invoice recipient to allocate the business case in his bookkeeping.