# Retrieve an invoice master plan

Required scopes: outgoing-invoice:read

Endpoint: GET /outgoing-invoices/master/{id}
Version: v1
Security: http, oauth2

## Path parameters:

  - `id` (string, required)

## Query parameters:

  - `find_by` (string)
    The field to search by
    Enum: "id", "external_id"

  - `origin` (string)
    Used if find_by=external_id by default it will use the integration slug

## Response 200 fields (application/json):

  - `id` (string, required)

  - `title` (string, required)

  - `type` (string, required)
    | |
|---|
| once  If type is once, then the master is a partial plan |
| recurring1  Recurring every month |
| recurring3  Recurring every 3 months |
| recurring6  Recurring every 6 months |
| recurring12  Recurring every 12 months |
    Enum: "once", "recurring1", "recurring3", "recurring6", "recurring12"

  - `performance_range_start` (string,null, required)

  - `performance_range_end` (string,null, required)

  - `locale` (string, required)

  - `currency` (string, required)

  - `address` (string, required)

  - `address_changed` (boolean, required)
    If true the user manually overwrote the companies address

  - `company` (any, required)

  - `editor` (any, required)

  - `client` (any, required)

  - `project` (any, required)

  - `taxation_enabled` (boolean, required)
    Can be used to indicate reverse charge ie

  - `sum_net` (number, required)

  - `sum_tax` (number, required)

  - `sum_gross` (number, required)

  - `sum_external_costs` (number, required)

  - `payment_discount` (number,null, required)
    Factor in percentage

  - `discounts` (array, required)

  - `discounts.discount_factor` (number,null, required)
    Discount in percent

  - `discounts.discount_absolute` (number,null, required)
    Is not calculated with invoices partial_factor in mind

  - `discounts.from_parent` (boolean, required)
    If true, the discount was set in invoice master

  - `discounts.is_payment_discount` (boolean, required)
    If true this discount was granted due to payment discount rules

  - `discounts.order` (integer, required)
    The order how discounts are applied

  - `line_items` (array, required)

  - `line_items.type` (string, required)
    Enum: "unit", "category", "page_break"

  - `line_items.indent` (integer, required)

  - `line_items.order` (integer, required)

  - `line_items.price` (number, required)
    Is always the full price of the unit (without partial_factor)
See partial_factor if element is part of an partial invoice

  - `line_items.amount` (number, required)

  - `line_items.total_net_base` (number, required)
    Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

  - `line_items.total_net_without_discount` (number, required)
    Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

  - `line_items.total_net` (number, required)
    Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice

  - `line_items.total_gross_base` (number, required)
    Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

  - `line_items.total_gross_without_discount` (number, required)
    Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

  - `line_items.total_gross` (number, required)
    Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice

  - `line_items.tax_factor` (number, required)

  - `line_items.metric` (object, required)

  - `line_items.metric.title_plural` (string, required)

  - `line_items.partial_factor` (integer,null, required)
    Value in percent. Describes the part of the unit that is included in the invoice

  - `line_items.exclude_from_discount` (boolean, required)
    If true, the unit will be excluded from offer-wide discounts

  - `line_items.discount_factor` (number,null, required)

  - `line_items.discount_absolute` (number,null, required)

  - `line_items.discount_bound` (boolean, required)
    If true, the amount will multiply discount absolute

  - `line_items.purchase_price` (number, required)

  - `line_items.purchase_amount` (number, required)

  - `line_items.purchase_total_base` (number, required)
    Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

  - `line_items.purchase_total` (number, required)
    Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

  - `line_items.purchase_price_bound` (boolean, required)
    If true, purchase_amount will be in sync with amount

  - `line_items.description` (string, required)

  - `line_items.payment_partial_type` (string, required)
    Enum: "once", "monthly", "yearly"

  - `line_items.payment_partial_interval` (integer,null, required)
    Interval if payment partial type is monthly or yearly
| Type | Interval | Description |
| ---- | -------- | ----------- |
| once | any | Once per offer |
| monthly | 1 | Every month in performance range |
| monthly | 3 | Every 3 months in performance range |
| monthly | 6 | Every 6 monthsin performance range  |
| yearly | 1 | Every year in performance range  |
| yearly | 3 | Every 3 years in performance range |
| yearly | 6` | Every 6 years in performance range |

  - `external_costs` (array, required)
    For partial invoices external costs will be empty - these are part of the invoice master plan

  - `external_costs.is_credit` (boolean, required)
    if true this cost is a credit

  - `external_costs.is_optional` (boolean, required)

  - `external_costs.price` (number, required)

  - `external_costs.total` (number, required)

  - `external_costs.supplier` (any, required)

  - `external_costs.status` (string,null, required)

  - `external_costs.created_at` (string, required)

  - `external_costs.updated_at` (string,null, required)

  - `deleted_at` (string,null, required)

  - `computed_fields` (object)

## Response 401 fields (application/json):

  - `message` (string, required)
    Error overview.

## Response 422 fields (application/json):

  - `message` (string, required)
    Errors overview.

  - `errors` (object, required)
    A detailed description of each field that failed validation.