Toast Payout by sales date API

openapi: 3.2.0
info:
  title: Analytics Payout by sales date API
  description: 'The analytics API provides an enterprise reporting and analytics service,

    and includes operations that retrieve information for all restaurants, or a

    subset of restaurants, in a management group, create requests for reporting data,

    and retrieve the reporting data.'
  version: 1.0.0
  contact:
    name: Toast developer support
servers:
- url: https://toast-api-server/era/v1
tags:
- name: Payout by sales date
  description: The analytics API endpoint for payout reporting data organized by sales date.
paths:
  /payout/sales-date/{timeRange}:
    post:
      summary: Post a payout data request organized by sales date for a specific time range
      description: 'Creates a payout reporting data organized by sales date request for a specific time range.


        Specify the time range with the `timeRange` path parameter.


        Specify whether to include data from inactive restaurants using the `onlyInactiveRestaurants` query parameter.


        Specify the `startDate` and `endDate` for the payout data in the message body.


        Include information about which restaurants to include or exclude with the

        `restaurantIds` and `excludedRestaurantIds` properties.'
      operationId: postPayoutReportSalesDateSpecificTimeRange
      parameters:
      - name: timeRange
        description: 'The specific time range that you are requesting reporting data for.


          Valid values:


          * `day` - The request covers a one day time range.


          * `week` - The request covers a time range of seven days or fewer.


          * `month` - The request covers a time range of 31 days or fewer.

          '
        in: path
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
      - name: onlyInactiveRestaurants
        description: "Specifies whether the data is for inactive restaurants only. Active restaurant data is \nreturned by default.\n\nValid values:\n\n* `true` - The data retrieved is for inactive restaurants only.\n\n* `false` - The data retrieved is for active restaurants only.\n"
        in: query
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoutSalesDateReportingDataRequest'
        description: 'A JSON object containing the starting and ending dates for the reporting data request and included or excluded restaurants.

          '
        required: true
      responses:
        '200':
          description: The `reportRequestGuid` used to retrieve the reporting data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportRequestGuid'
        '400':
          description: The request contains invalid information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: 'An unexpected internal error occurred. The

            `requestId` attached to this error can be referenced by

            the Toast support team.

            '
      security:
      - oauth2:
        - enterprise-metrics:read
      tags:
      - Payout by sales date
  /payout/sales-date/{reportRequestGuid}:
    get:
      summary: Get the payout reporting data organized by sales date
      description: 'Returns the payout data organized by sales date for the reporting data request.


        Specify the `reportRequestGuid` for the reporting data.'
      operationId: getPayoutSalesDateReportingData
      parameters:
      - name: reportRequestGuid
        description: The Toast platform identifier for the reporting data request.
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The reporting data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutSalesDateReportingData'
        '202':
          description: The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportingDataInProgress'
        '404':
          description: An unexpected error occurred. Refer to the `message` attached to this error for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '409':
          description: The Toast platform was unable to process the request. Request a new `reportRequestGuid` and try again.
        '500':
          description: 'An unexpected internal error occurred. The

            `requestId` attached to this error can be referenced by

            the Toast support team.

            '
        '504':
          description: The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.
      security:
      - oauth2:
        - enterprise-metrics:read
      tags:
      - Payout by sales date
components:
  schemas:
    ReportingDataInProgress:
      description: The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.
      type: object
      properties:
        message:
          description: A brief message describing that the reporting data is still in progress and to try again at a later time.
          format: string
          type: string
        reportStatus:
          description: Reflects the in progress status of the reporting data using the IN_PROGRESS value.
          format: text
          type: string
        reportRequestGuid:
          description: The Toast platform assigned identifier used to identify a specific analytics reporting data request.
          format: UUID
          type: string
    ErrorMessage:
      type: object
      description: Information about an unsuccessful REST request.
      properties:
        status:
          description: The HTTP status code.
          format: integer
          type: number
        code:
          description: The service-specific result code.
          format: integer
          type: number
        message:
          description: A brief message describing the error.
          type: string
        messageKey:
          description: Reserved for future use.
          type: string
        fieldName:
          description: Reserved for future use.
          type: string
        link:
          description: The URL of a Toast page that provides more information about the error.
          format: URL
          type: string
        requestId:
          description: The identifier of the HTTP request that generated the error.
          format: UUID
          type: string
        developerMessage:
          description: Optional, technical information to help a developer investigate the cause of the error.
          type: string
        errors:
          description: A list of JSON `ErrorMessage` objects.
          items:
            type: string
          type: array
        canRetry:
          description: Reserved for future use.
          type: string
    ReportRequestGuid:
      description: The Toast platform assigned identifier used to identify a specific analytics reporting data request.
      format: UUID
      type: string
    PayoutSalesDateReportingDataRequest:
      description: 'Information about what the payout data organized by sales date covers and how it is presented.

        This includes the starting and ending dates of the time range, and the included or excluded restaurants.

        '
      type: object
      properties:
        startDate:
          description: 'The starting date of the time range for the reporting data.

            Specify the date in the format YYYYMMDD. For example, `20220824`.

            '
          format: integer
          type: number
        endDate:
          description: 'The ending date of the time range for the reporting data.

            Specify the date in the format YYYYMMDD. For example, `20220824`.

            '
          format: integer
          type: number
        restaurantIds:
          description: "The `restaurantGuid` values of specific restaurants in the management group to include in the \nreporting data. If used, only the data for listed restaurants in the management group \nthat are identified by `restaurantGuid` is included. If left blank, all restaurants are included \nby default.\n"
          items:
            format: uuid
            type: string
          type: array
        excludedRestaurantIds:
          description: "The `restaurantGuid` values of specific restaurants in the management group to exclude from the \nreporting data. If used, the data for listed restaurants in the management group \nthat are identified by `restaurantGuid` is excluded. If left blank, all restaurants are included \nby default.\n"
          items:
            format: UUID
            type: string
          type: array
      required:
      - restaurantIds
      - excludedRestaurantIds
      - startDate
      - endDate
    PayoutSalesDateReportingData:
      description: The payout reporting data organized by sales date.
      type: object
      properties:
        restaurantGuid:
          description: 'The identifier assigned by the Toast platform used to identify a restaurant location.

            '
          format: UUID
          type: string
        restaurantName:
          description: 'The restaurant’s name.

            '
          format: string
          type: string
        restaurantLocationName:
          description: 'The restaurant’s location name.

            '
          format: string
          type: string
        restaurantLocationCode:
          description: 'The restaurant’s location code.

            '
          format: string
          type: string
        salesDate:
          description: 'The date when the payment was completed. The sales date is considered the same as the order payment date.

            '
          format: integer
          type: string
        settledDates:
          description: 'The date when the payouts associated with the payment were either processed or settled.

            '
          items:
            format: integer
            type: string
          type: array
        transactionCount:
          description: 'The number of transactions made on the sales date.

            '
          format: integer
          type: number
        paymentAmount:
          description: 'The amount paid to the restaurant by guests using cards on the sales date.

            '
          format: double
          type: number
        refundAmount:
          description: 'The amount refunded to guests by the restaurant for payments made on the sales date.

            '
          format: double
          type: number
        totalFeeAmount:
          description: 'The amount paid or owed by the restaurant in fees associated with payments made on the sales date.

            An example is the processing fees charged by card providers on payments.

            '
          format: double
          type: number
        withholdingAmount:
          description: 'The amount owed to Toast by the restaurant for products and services. For example, this includes Toast Capital, Fundraising, and Instant Deposit.

            '
          format: double
          type: number
        payoutAmount:
          description: 'The amount to be deposited into the restaurant’s account. This amount is calculated by subtracting the refund, fee, and withholding amounts from the payment amount.

            '
          format: double
          type: number
  securitySchemes:
    oauth2:
      description: "Access to Toast APIs, specific endpoints, \nand specific API endpoint operations is \ncontrolled by the scopes that are associated \nwith your API account. \n\nA full reference for Toast API scopes and \ntheir capabilities can be found in the\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\n"
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://toast-api-server/authentication/v1/authentication/login
          scopes:
            enterprise-metrics:read: 'Allows reading from the analytics API.

              '
x-components: {}