# List savings plan executions

List savings plan executions for a saving plan specified by its ID.

Endpoint: GET /savings_plans/{savings_plan_id}/executions
Version: 1.113.0
Security: oauth-client-credentials

## Path parameters:

  - `savings_plan_id` (string, required)

## Header parameters:

  - `upvest-client-id` (string, required)
    Tenant Client ID
    Example: "363f3305-7ab0-4e82-a158-f9d382ad08b6"

  - `Authorization` (string, required)
    Bearer (access) token from the OAuth flow with correct scopes.
https://datatracker.ietf.org/doc/html/rfc6750
    Example: "Bearer c2VjcmV0Cg=="

  - `signature` (string, required)
    https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

  - `signature-input` (string, required)
    https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

  - `upvest-api-version` (string)
    Upvest API version (Note: Do not include quotation marks)
    Enum: "1"

## Query parameters:

  - `start_date` (string)
    Returns savings plan executions starting from and including this date (UTC)
    Example: "2022-10-14T10:10:10Z"

  - `end_date` (string)
    Returns savings plan executions up to this date (UTC)
    Example: "2022-10-14T10:10:10Z"

  - `sort` (string)
    Sort the result by execution_date.
    Enum: "execution_date"

  - `order` (string)
    Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.
    Enum: "ASC"

  - `offset` (integer)
    Use the offset argument to specify where in the list of results to start when returning items for a particular query.

  - `limit` (integer)
    Use the limit argument to specify the maximum number of items returned.

## Response 200 fields (application/json):

  - `meta` (object, required)

  - `meta.offset` (integer, required)
    Amount of resource to offset in the response.

  - `meta.limit` (integer, required)
    Total limit of the response.

  - `meta.count` (integer, required)
    Count of the resources returned in the response.

  - `meta.total_count` (integer, required)
    Total count of all the resources.

  - `meta.sort` (string)
    The field that the list is sorted by.

  - `meta.order` (string)
    The ordering of the response.
* ASC - Ascending order
* DESC - Descending order
    Enum: "ASC", "DESC"

  - `data` (array, required) — one of:
    - Savings plan execution (instrument):
      - `id` (string, required)
      - `user_id` (string, required)
        User unique identifier.
      - `account_id` (string, required)
        Account unique identifier.
      - `savings_plan_id` (string, required)
      - `order_id` (any, required)
        Order unique identifier (Portfolio order or Instrument order)
        - `id` (string, required)
        - `created_at` (string, required)
          Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `updated_at` (string, required)
          Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `account_id` (string, required)
          The ID of the account that owns the order
        - `cash_amount` (string, required)
          Cash amount for a nominal order, not required if a share quantity is specified.
        - `currency` (string, required)
          Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - British Pound
          Enum: "EUR", "GBP"
        - `side` (string, required)
          Side of the order.
* BUY - 
* SELL -
          Enum: "BUY", "SELL"
        - `instrument_id` (string, required)
          International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number).
        - `instrument_id_type` (string, required)
          The type of the ID used in the request.
* ISIN -
          Enum: "ISIN"
        - `order_type` (string, required)
          Type of the order.
* MARKET - 
* LIMIT - 
* STOP -
          Enum: "MARKET", "LIMIT", "STOP"
        - `quantity` (string, required)
          Quantity of securities for the order. Only required if the cash amount is not specified.
        - `status` (string, required)
          The execution status of the order.
* NEW - 
* PROCESSING - 
* FILLED - 
* CANCELLED -
          Enum: "NEW", "PROCESSING", "FILLED", "CANCELLED"
        - `fee` (string, required)
        - `initiation_flow` (string, required)
          Initiation flow used during order creation, i.e. what triggered the order.
* API - 
* PORTFOLIO - 
* CASH_DIVIDEND_REINVESTMENT - 
* PORTFOLIO_REBALANCING - 
* SELL_TO_COVER_FEES - 
* SELL_TO_COVER_TAXES - 
* ACCOUNT_LIQUIDATION - 
* UPVEST_OPERATIONS - 
* SAVINGS_PLAN -
          Enum: "API", "PORTFOLIO", "CASH_DIVIDEND_REINVESTMENT", "PORTFOLIO_REBALANCING", "SELL_TO_COVER_FEES", "SELL_TO_COVER_TAXES", "ACCOUNT_LIQUIDATION", "UPVEST_OPERATIONS", "SAVINGS_PLAN"
        - `executions` (array, required)
          Order executions associated with this order
        - `executions.id` (string, required)
        - `executions.cash_amount` (string, required)
        - `executions.share_quantity` (string, required)
        - `executions.price` (string, required)
        - `executions.transaction_time` (string, required)
        - `executions.taxes` (array, required)
        - `executions.taxes.type` (string, required)
          Tax type
* TOTAL -
          Enum: "TOTAL"
        - `executions.taxes.amount` (string, required)
        - `executions.order_id` (string, required)
        - `executions.status` (string, required)
          Execution status of the Execution.
* FILLED - 
* SETTLED - 
* CANCELLED -
          Enum: "FILLED", "SETTLED", "CANCELLED"
        - `executions.side` (string, required)
          Side of the execution.
* BUY - 
* SELL -
          Enum: same as `side` (2 values)
        - `executions.currency` (string, required)
          Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - British Pound
          Enum: same as `currency` (2 values)
        - `executions.venue_id` (string, required)
          The ID of the venue
        - `executions.settlement_date` (string)
          Order execution settlement date in the YYYY-MM-DD format. [RFC 3339, section 5.6](https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339) RFC 3339
        - `user_id` (string)
          The ID of the user. Either user ID or business ID must be specified.
        - `business_id` (string)
          The ID of the business. Either user ID or business ID must be specified.
        - `user_instrument_fit_acknowledgement` (boolean)
          Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
        - `limit_price` (string)
          The limit price for orders of the type 'limit'.
        - `stop_price` (string)
          The stop price for orders of the type 'stop'.
        - `expiry_date` (string)
          The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. [RFC 3339, section 5.6](https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339) RFC 3339. The default value is order creation date + 359 days
        - `cancellation_reason` (string)
          Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED.
* CANCELLED_BY_CLIENT - 
* CANCELLED_BY_UPVEST_OPERATIONS - 
* CANCELLED_BY_TRADING_PARTNER - 
* CANCELLED_BY_UPVEST_PLATFORM -
          Enum: "CANCELLED_BY_CLIENT", "CANCELLED_BY_UPVEST_OPERATIONS", "CANCELLED_BY_TRADING_PARTNER", "CANCELLED_BY_UPVEST_PLATFORM"
        - `execution_flow` (string)
          Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.
* STRAIGHT_THROUGH - 
* BLOCK -
          Enum: "STRAIGHT_THROUGH", "BLOCK"
        - `client_reference` (string)
          Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.
        - `fee_configuration` (array) — one of:
          fee configuration
          - Absolute Fee:
            - `type` (string, required)
              Fee type
* TRANSACTION_FEE_BUY - 
* TRANSACTION_FEE_SELL -
              Enum: "TRANSACTION_FEE_BUY", "TRANSACTION_FEE_SELL"
            - `value_type` (string, required)
              The value type must be “ABSOLUTE”.
            - `charge_method` (string, required)
              Indicates whether the fee will be charged by client or by other methods.
* CHARGED_BY_CLIENT - 
* COLLECTED_BY_UPVEST -
              Enum: "CHARGED_BY_CLIENT", "COLLECTED_BY_UPVEST"
            - `cash_amount` (string, required)
            - `currency` (string, required)
              Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - British Pound
              Enum: same as `currency` (2 values)
          - Transaction Fee Model:
            - `type` (string, required)
              Fee type
* TRANSACTION_FEE_BUY - 
* TRANSACTION_FEE_SELL -
              Enum: same as `type` in "Absolute Fee" (2 values)
            - `transaction_fee_model_id` (string, required)
              The ID of the transaction fee model.
        - `decision_maker_id` (string)
          ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)
      - `cash_amount` (string, required)
      - `currency` (string, required)
        Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - Pound Sterling
        Enum: same as `currency` (2 values)
      - `status` (string, required)
        Status of a Savings Plan Execution. 
* NEW - 
* PROCESSING - 
* FILLED - 
* SETTLED - 
* CANCELLED -
        Enum: "NEW", "PROCESSING", "FILLED", "SETTLED", "CANCELLED"
      - `type` (string, required)
        The type of savings plan must be "INSTRUMENT".
      - `execution_date` (string, required)
        Date of a savings plan execution in YYYY-MM-DD format.
      - `created_at` (string, required)
        Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
      - `updated_at` (string, required)
        Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
      - `instrument_id` (any)
        Instrument unique identifier.
      - `instrument_id_type` (string)
        The type of the ID used in the request.
* ISIN - International Securities Identification Number
* WKN - German securities identification code
        Enum: "ISIN", "WKN"
      - `fee_configuration` (array)
      - `fee_configuration.type` (string, required)
        Fee type
* TRANSACTION_FEE_BUY -
        Enum: "TRANSACTION_FEE_BUY"
      - `fee_configuration.transaction_fee_model_id` (string, required)
        Fee model unique identifier.
    - Savings plan execution (portfolio):
      - `id` (string, required)
      - `user_id` (string, required)
        User unique identifier.
      - `account_id` (string, required)
        Account unique identifier.
      - `savings_plan_id` (string, required)
      - `order_id` (any, required)
        Order unique identifier (Portfolio order or Instrument order)
        - `id` (string, required)
        - `created_at` (string, required)
          Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `updated_at` (string, required)
          Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
        - `account_id` (string, required)
          The ID of the account that owns the order
        - `cash_amount` (string, required)
          Cash amount for a nominal order, not required if a share quantity is specified.
        - `currency` (string, required)
          Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - British Pound
          Enum: same as `currency` (2 values)
        - `side` (string, required)
          Side of the order.
* BUY - 
* SELL -
          Enum: same as `side` (2 values)
        - `instrument_id` (string, required)
          International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number).
        - `instrument_id_type` (string, required)
          The type of the ID used in the request.
* ISIN -
          Enum: same as `instrument_id_type` (1 values)
        - `order_type` (string, required)
          Type of the order.
* MARKET - 
* LIMIT - 
* STOP -
          Enum: same as `order_type` (3 values)
        - `quantity` (string, required)
          Quantity of securities for the order. Only required if the cash amount is not specified.
        - `status` (string, required)
          The execution status of the order.
* NEW - 
* PROCESSING - 
* FILLED - 
* CANCELLED -
          Enum: same as `status` (4 values)
        - `fee` (string, required)
        - `initiation_flow` (string, required)
          Initiation flow used during order creation, i.e. what triggered the order.
* API - 
* PORTFOLIO - 
* CASH_DIVIDEND_REINVESTMENT - 
* PORTFOLIO_REBALANCING - 
* SELL_TO_COVER_FEES - 
* SELL_TO_COVER_TAXES - 
* ACCOUNT_LIQUIDATION - 
* UPVEST_OPERATIONS - 
* SAVINGS_PLAN -
          Enum: same as `initiation_flow` (9 values)
        - `executions` (array, required)
          Order executions associated with this order
        - `executions.id` (string, required)
        - `executions.cash_amount` (string, required)
        - `executions.share_quantity` (string, required)
        - `executions.price` (string, required)
        - `executions.transaction_time` (string, required)
        - `executions.taxes` (array, required)
        - `executions.taxes.type` (string, required)
          Tax type
* TOTAL -
          Enum: same as `executions.taxes.type` (1 values)
        - `executions.taxes.amount` (string, required)
        - `executions.order_id` (string, required)
        - `executions.status` (string, required)
          Execution status of the Execution.
* FILLED - 
* SETTLED - 
* CANCELLED -
          Enum: same as `executions.status` (3 values)
        - `executions.side` (string, required)
          Side of the execution.
* BUY - 
* SELL -
          Enum: same as `side` (2 values)
        - `executions.currency` (string, required)
          Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - British Pound
          Enum: same as `currency` (2 values)
        - `executions.venue_id` (string, required)
          The ID of the venue
        - `executions.settlement_date` (string)
          Order execution settlement date in the YYYY-MM-DD format. [RFC 3339, section 5.6](https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339) RFC 3339
        - `user_id` (string)
          The ID of the user. Either user ID or business ID must be specified.
        - `business_id` (string)
          The ID of the business. Either user ID or business ID must be specified.
        - `user_instrument_fit_acknowledgement` (boolean)
          Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
        - `limit_price` (string)
          The limit price for orders of the type 'limit'.
        - `stop_price` (string)
          The stop price for orders of the type 'stop'.
        - `expiry_date` (string)
          The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. [RFC 3339, section 5.6](https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339) RFC 3339. The default value is order creation date + 359 days
        - `cancellation_reason` (string)
          Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED.
* CANCELLED_BY_CLIENT - 
* CANCELLED_BY_UPVEST_OPERATIONS - 
* CANCELLED_BY_TRADING_PARTNER - 
* CANCELLED_BY_UPVEST_PLATFORM -
          Enum: same as `cancellation_reason` (4 values)
        - `execution_flow` (string)
          Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.
* STRAIGHT_THROUGH - 
* BLOCK -
          Enum: same as `execution_flow` (2 values)
        - `client_reference` (string)
          Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.
        - `fee_configuration` (array) — one of:
          fee configuration
          - Absolute Fee:
            - `type` (string, required)
              Fee type
* TRANSACTION_FEE_BUY - 
* TRANSACTION_FEE_SELL -
              Enum: same as `type` in "Absolute Fee" (2 values)
            - `value_type` (string, required)
              The value type must be “ABSOLUTE”.
            - `charge_method` (string, required)
              Indicates whether the fee will be charged by client or by other methods.
* CHARGED_BY_CLIENT - 
* COLLECTED_BY_UPVEST -
              Enum: same as `charge_method` in "Absolute Fee" (2 values)
            - `cash_amount` (string, required)
            - `currency` (string, required)
              Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - British Pound
              Enum: same as `currency` (2 values)
          - Transaction Fee Model:
            - `type` (string, required)
              Fee type
* TRANSACTION_FEE_BUY - 
* TRANSACTION_FEE_SELL -
              Enum: same as `type` in "Absolute Fee" (2 values)
            - `transaction_fee_model_id` (string, required)
              The ID of the transaction fee model.
        - `decision_maker_id` (string)
          ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)
      - `cash_amount` (string, required)
      - `currency` (string, required)
        Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
* EUR - Euro
* GBP - Pound Sterling
        Enum: same as `currency` (2 values)
      - `status` (string, required)
        Status of a Savings Plan Execution. 
* NEW - 
* PROCESSING - 
* FILLED - 
* SETTLED - 
* CANCELLED -
        Enum: same as `status` in "Savings plan execution (instrument)" (5 values)
      - `type` (string, required)
        The type of savings plan must be "PORTFOLIO".
      - `execution_date` (string, required)
        Date of a savings plan execution in YYYY-MM-DD format.
      - `created_at` (string, required)
        Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
      - `updated_at` (string, required)
        Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
      - `instrument_id` (any)
        Instrument unique identifier.
      - `instrument_id_type` (string)
        The type of the ID used in the request.
* ISIN - International Securities Identification Number
* WKN - German securities identification code
        Enum: same as `instrument_id_type` in "Savings plan execution (instrument)" (2 values)

## Response 400 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 401 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 403 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 404 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 405 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 406 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 429 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 500 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 503 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 504 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.