CloudKitchens Finance Endpoints API

openapi: 3.2.0
info:
  title: Public Finance Endpoints API
  description: '# Overview


    The API endpoints are developed around RESTful principles secure via the OAuth2.0 protocol.'
  version: v1
  license:
    name: Proprietary
servers:
- url: https://{{public-api-url}}
  description: Staging server url
tags:
- name: Finance Endpoints
  description: Endpoints to handle financial data.
  x-displayName: Finance
paths:
  /finance/v1/financial-transactions:
    post:
      tags:
      - Finance Endpoints
      summary: Post financial transactions
      operationId: postFinancialTransactions
      description: Post financial data related to a given order.
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialTransaction'
        required: true
      responses:
        '202':
          description: The financial transaction for the order was successfully processed.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - finance
  /finance/v1/financial-invoices:
    post:
      tags:
      - Finance Endpoints
      summary: Post a financial invoice
      operationId: postFinancialInvoice
      description: Post a financial invoice containing payout and financial data for orders in a given period of time.
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialInvoice'
        required: true
      responses:
        '202':
          description: The financial transaction for the order was successfully processed.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - finance
components:
  schemas:
    CompositeFinanceLine:
      required:
      - breakdown
      type: object
      properties:
        breakdown:
          type: array
          minItems: 1
          description: Breakdown values for the finance line.
          items:
            $ref: '#/components/schemas/SimpleFinanceLine'
      description: composite finance line can represent a value, tax and VAT for a given line as a list of SimpleFinanceLine objects
    OrderIssue:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: Order issue type.
          enum:
          - MISSING_ITEM
          - INCOMPLETE
          - WRONG_INGREDIENTS
          - WRONG_SIZE
          - WRONG_INSTRUCTIONS
          - TEMPERATURE_COLD
          - WRONG_ORDER
          - POOR_QUALITY
          - HANDLED_POORLY
          - WRONG_ITEM
          - WRONG_QUANTITY
          - LATE_TO_COURIER
    FinancialData:
      required:
      - foodSales
      type: object
      properties:
        foodSales:
          description: Breakdown of the total value of items within the order.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        feeForRestaurantProvidedDelivery:
          description: Extra charge to the customer when order is delivered by the store itself.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        restaurantFundedDiscount:
          description: Discount funded by the restaurant.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        voucherDiscount:
          description: Discount provided by voucher.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        promotionDiscount:
          description: Discount provided by item promotion.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        operatorDiscount:
          description: Discount provided by operator when the order was placed.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        loyaltyDiscount:
          description: Discount provided by loyalty programs.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        tipForRestaurant:
          description: Tip for the restaurant.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        adjustments:
          description: Any adjustments that may happen to the order total value.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        packingFee:
          description: Fee charged to the customer for the process of packing and fulfilling the order.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        bagFee:
          description: Fee charged to the customer for providing bags for the order.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        serviceProviderDiscount:
          description: Discount funded by the service provider (order source).
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        tipForServiceProviderCourier:
          description: Tip for the courier from the service provider.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        feeForServiceProviderDelivery:
          description: Fee charged to the customer for a delivery provided by the service provider.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        smallOrderFee:
          description: Fee charged to the customer when the order value is less than the minimum value.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        serviceFee:
          description: Any service fees charged by the service provider to the customer.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        otherFee:
          description: All the extra costs that the customer has to pay, are different from tips, delivery fees, bag fees, packing fees, and service fees.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        netPayout:
          description: The net payout received by the store.
          allOf:
          - $ref: '#/components/schemas/CompositeFinanceLine'
        couponCodes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Any codes entered by the customer at order checkout.
          example:
          - TACOWED5OFF
      description: "Breakdown of order values. Represents total values, fees, discounts, and any possible adjustments that may happen in the order value.\n\nBreakdown lists can be used to represent aggregate values (e.g. order total value) or, when available, can accurately represent the values of each item/fee/tax/charges related to the order.\n\nAll objects in breakdown lists have a required property \"subType\". Allowed values are:\n\n**VALUE**: represent the net value of the order/item/fee. Should be used in the following cases:\n - when the amount does not contain taxes or VAT\n - when tax/VAT is a known value, in that case, the list must contain an object with subtype TAX or VAT representing this value.\n\n**TAX**: represent the tax value for the order/item/fee. Should be used when tax amount is available, in that case, this information should be part of the breakdown list with the \"VALUE\" as the net amount, example below:\n\n\n  ```\n    \"breakdown\": [\n        {\n            \"name\": \"Item 1\",\n            \"value\": 10,\n            \"subType\": \"VALUE\"\n        },\n        {\n            \"name\": \"Item 1 - Tax\",\n            \"value\": 2,\n            \"subType\": \"TAX\"\n        }\n    ]\n  ```\n\n\n**VAT**: represents the amount for value-added tax. Should be used when the order/item/fee contains VAT. In that case,  this information should be part of the breakdown list with the \"VALUE\" as net amount, example below:\n\n\n  ```\n    \"breakdown\": [\n        {\n            \"name\": \"Item 1\",\n            \"value\": 12,\n            \"subType\": \"VALUE\"\n        },\n        {\n            \"name\": \"Item 1 - Tax\",\n            \"value\": 2,\n            \"subType\": \"VAT\"\n        }\n    ]\n  ```\n\n\n**VALUE_WITH_TAX**: represents the gross value of the order/item/fee. Should be used when the value includes tax/VAT and values related to taxation are not available.\n\n\n  ```\n    \"breakdown\": [\n        {\n            \"name\": \"Item 1\",\n            \"value\": 12,\n            \"subType\": \"VALUE_WITH_TAX\"\n        }\n    ]\n  ```"
    SimpleFinanceLine:
      required:
      - subType
      - name
      - value
      type: object
      properties:
        subType:
          type: string
          enum:
          - VALUE
          - TAX
          - VALUE_WITH_TAX
          - VAT
          description: type of the finance line.
        name:
          type: string
          description: name of the finance line.
          example: sales tax.
        value:
          type: number
          description: money amount.
          example: 3.4
      description: simple finance line.
    StoreId:
      type: string
      description: The unique identifier of the store in the partner application. This ID, along with the `Application ID`, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to `onboarding:905bb725-b141-4a9b-832a-1f254f772c94` (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided `internalStoreId` (a.k.a. Sku-Sku ID).
      example: partner-store-unique-identifier
    FinancialTransaction:
      required:
      - id
      - orderIdentifiers
      - pending
      - currencyCode
      - createdAt
      - type
      - data
      type: object
      properties:
        orderIdentifiers:
          $ref: '#/components/schemas/OrderIdentifierFinance'
        id:
          type: string
          description: External financial transaction identifier.
        pending:
          type: boolean
          description: Whether the transaction can be updated in the future.
        currencyCode:
          maxLength: 3
          minLength: 3
          type: string
          description: The 3-letter currency code (ISO 4217) to use for all monetary values in this order.
          example: EUR
        createdAt:
          type: string
          description: The date (in UTC) when the financial transaction was created.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        customerId:
          type:
          - string
          - 'null'
          description: Customer identifier.
        notes:
          type:
          - string
          - 'null'
          description: General notes about the financial transaction.
        type:
          type: string
          description: Financial transaction operation type.
          enum:
          - PAYMENT
          - ADJUSTMENT
          - CANCELLATION
          - MISC
        payout:
          $ref: '#/components/schemas/PayoutInfo'
        orderItems:
          type:
          - array
          - 'null'
          description: Detailed financial per order item.
          items:
            $ref: '#/components/schemas/OrderItemInformation'
        issues:
          type:
          - array
          - 'null'
          description: List of issues that might have happened with the order.
          items:
            $ref: '#/components/schemas/OrderIssue'
        data:
          $ref: '#/components/schemas/FinancialData'
    SimpleOrderIdentifierFinance:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Unique ID for the order that was placed.
          example: 69f60a06-c335-46d9-b5a1-97f1a211c514
      description: The external identifiers of the order.
    OrderIdentifierFinance:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Unique ID for the order that was placed.
          example: 69f60a06-c335-46d9-b5a1-97f1a211c514
        source:
          type:
          - string
          - 'null'
          description: Describes the source of the order, typically from a food ordering marketplace.
          example: ubereats
      description: The external identifiers of the order.
    ErrorMessage:
      type: object
      properties:
        message:
          type: string
          description: The error description.
          example: The request body is invalid.
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
      description: The error response object.
    InvoicePayoutInfo:
      required:
      - id
      - date
      type: object
      properties:
        id:
          type: string
          description: Payout identifier.
        date:
          type: string
          description: The payout date.
          format: date
          example: '2021-10-01'
        summary:
          $ref: '#/components/schemas/FinancialData'
        total:
          type:
          - number
          - 'null'
          description: Total payout value. Should only be used if summary is not provided.
          example: 19.07
    FinancialInvoice:
      required:
      - payout
      - financialTransactions
      type: object
      properties:
        sourceService:
          type:
          - string
          - 'null'
          description: Describes the source of the order, typically from a food ordering marketplace.
          example: ubereats
        payout:
          $ref: '#/components/schemas/InvoicePayoutInfo'
        financialTransactions:
          type: array
          description: List of financial transactions related to this invoice.
          items:
            $ref: '#/components/schemas/SimpleFinancialTransaction'
        currencyCode:
          maxLength: 3
          minLength: 3
          type: string
          description: The 3-letter currency code (ISO 4217) to use for all monetary values in this order.
          example: EUR
    OrderItemInformation:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Regular item identifier.
        name:
          type:
          - string
          - 'null'
          description: Item name
        issues:
          type:
          - array
          - 'null'
          description: Order issues that relate to this item.
          items:
            $ref: '#/components/schemas/OrderIssue'
    SimpleFinancialTransaction:
      required:
      - id
      - orderIdentifiers
      - createdAt
      - type
      - data
      type: object
      properties:
        orderIdentifiers:
          $ref: '#/components/schemas/SimpleOrderIdentifierFinance'
        id:
          type: string
          description: External financial transaction identifier.
        createdAt:
          type: string
          description: The date (in UTC) when the financial transaction was created.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        customerId:
          type:
          - string
          - 'null'
          description: Customer identifier.
        notes:
          type:
          - string
          - 'null'
          description: General notes about the financial transaction.
        type:
          type: string
          description: Financial transaction operation type.
          enum:
          - PAYMENT
          - ADJUSTMENT
          - CANCELLATION
          - MISC
        orderItems:
          type:
          - array
          - 'null'
          description: Detailed financial per order item.
          items:
            $ref: '#/components/schemas/OrderItemInformation'
        issues:
          type:
          - array
          - 'null'
          description: List of issues that might have happened with the order.
          items:
            $ref: '#/components/schemas/OrderIssue'
        data:
          $ref: '#/components/schemas/FinancialData'
    ErrorDetail:
      type: object
      properties:
        attribute:
          type: string
          description: The error attribute.
          example: Order Currency Code
        message:
          type: string
          description: The error detail description.
          example: Order Currency Code must be exactly 3 characters
      description: The error detail response object.
    PayoutInfo:
      required:
      - id
      - date
      type: object
      properties:
        id:
          type: string
          description: Payout identifier.
        date:
          type: string
          description: The payout date.
          format: date
          example: '2021-10-01'
  responses:
    '401':
      description: Invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '400':
      description: The request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '404':
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '422':
      description: The request body is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '403':
      description: Authorization not valid for the requested resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  parameters:
    storeIdHeader:
      name: X-Store-Id
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/StoreId'
  securitySchemes:
    OAuth2.0:
      type: oauth2
      description: "The **Authorization API** is based on the [OAuth2.0 protocol](https://tools.ietf.org/html/rfc6749), supporting the (Client Credentials)[https://datatracker.ietf.org/doc/html/rfc6749#section-4.4] and the (Authorization Code)[https://datatracker.ietf.org/doc/html/rfc6749#section-4.1] flows. Resources expect a valid token sent as a `Bearer` token in the HTTP `Authorization` header.\n### Scopes\nScopes must be configured by our internal team to be enabled for an app. Once the scopes are configured they can be enabled on the Application Settings Page in Developer Portal. Each endpoint requires a given scope that can be verified on each endpoint documentation. When generating an OAuth2.0 token multiple scopes can be requested.\n\n### Authorization Code Flow\nTo perform this flow, the authorization code flow must be enabled in the Application Settings Page in Developer Portal. When enabling the flow it is mandatory to provide a redirect URI pointing to your application. Once the flow is complete we will redirect the user to this URI passing the 'code' and 'state' parameters.\nThe Authorization Code flow provides a temporary code that the client application can exchange for an access token. To start the flow the application must request the user authorization. This is done by sending a request to https://{{public-api-url}}/v1/auth/oauth2/authorize.\nExample\n```\ncurl --location 'https://{{public-api-url}}/v1/auth/oauth2/authorize?client_id=[CLIENT_ID]&redirect_uri=[REDIRECT_URI]&response_type=code&scope=organization.read&state=8A9D16B4C3E25F6A'\n```\nThis call will return a 302 redirecting the user to our authorization page. If the user approves the application, we will redirect to configured URI passing the authorization code in the query parameter 'code'. The 'state' parameter is also sent to ensure the source of the data.\nWith the authorization code, the client application can generate the token.\n### Client Credentials Flow\nThe client_credentials flow does not require any steps before generating the token. Once your application is ready, and the client_id and client_secret are available, the token can be generated by following the instructions in the next section.\n\n### Generate Token\nTo generate the token, use the `Client ID` and `Client Secret` (provided during onboarding), and optionally the authorization code obtained after performing the Authorization Code flow, to the [Token Auth endpoint](#operation/requestToken) endpoint. The result of this invocation is a token that is valid for a pre-determined time or until it is manually revoked.\n\nThe access token obtained will be sent as a `Bearer` value of the `Authorization` HTTP header.\n\nClient credentials in the request-body and HTTP Basic Auth are supported.\n\n#### Request Example for client_credentials\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/auth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'scope=ping' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'client_id=[APPLICATION_ID]' \\\n  --data-urlencode 'client_secret=[CLIENT_SECRET]'\n\n```\n#### Request Example for authorization_code\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/auth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'scope=ping' \\\n  --data-urlencode 'grant_type=authorization_code' \\\n  --data-urlencode 'client_id=[APPLICATION_ID]' \\\n  --data-urlencode 'client_secret=[CLIENT_SECRET]' \\\n  --data-urlencode 'code=[code]' \\\n  --data-urlencode 'redirect_uri=[redirect_uri]'\n\n```\n#### Response Example\n```\n{\n  \"access_token\": \"oMahtBwBbnZeh4Q66mSuLFmk2V0_CLCKVt0aYcNJlcg.yditzjwCP7yp0PgR6AzQR3wQ1rTdCjkcPeAMuyfK-NU\",\n  \"expires_in\": 2627999,\n  \"scope\": \"ping orders.create\",\n  \"token_type\": \"bearer\"\n}\n```\n\n### Token Usage\n\nThe token provided in field `access_token` is used to authenticate when consuming the API endpoints. Send the token value in the `Authorization` header of every request. The token expiration time is represented in the field `expired_in`, in seconds. Currently, all tokens are valid for 30 days and should be stored and re-used while still valid.\n\nNote that occasionally, a 401 error may be returned for a valid token due to an internal service issue. Such occurrences should be rare. To prevent exposing potential vulnerabilities to attackers, the Public API does not disclose other types of errors in the authentication flow if for any reason the token can't be validated (when it's a valid token then it's ok to return 5XX or other 4XX though - such as 403). In such scenarios, although the internal auth flow avoids retries to prevent attacks, if the token is known to be valid and not expired, a retry with a backoff interval by the client is advised. Another option is to request a new token.\n\n#### Example\n\n```\ncurl --location --request GET 'https://{{public-api-url}}/v1/ping' \\\n  --header 'Authorization: Bearer <access_token>' \\\n  --header 'X-Store-Id: <storeId>'\n\n```\n"
      flows:
        clientCredentials:
          tokenUrl: /v1/auth/token
          scopes:
            catalog: Permission to interact with product inventory for existing stores.
            delivery.provider: Permission to provide delivery services for existing orders.
            finance: Permission to provide financial data for orders/stores.
            manager.menus: Permission to manage menus.
            manager.orders: Permission to manage orders.
            manager.storefront: Permission to manage storefront.
            menus.async_job.read: Permission to read the status of a menu upsert job.
            menus.entity_suspension: Permission to notify the result of a menu entity availability update, after being requested by a webhook event.
            menus.get_current: Permission to send the current state of a menu, after being requested by a webhook event.
            menus.publish: Permission to notify the result of a publish menus operation for a given store.
            menus.read: Permission to read the current menus for a given store.
            menus.upsert: Permission to create/update menus for a given store.
            menus.upsert_hours: Permission to notify the receiving of the upsert hours menu event, after being requested by a webhook event.
            orders.create: Permission to create new order for a given store.
            orders.read: Permission to read orders and connected data.
            orders.update: Permission to create and update new orders for a given store.
            ping: Permission to ping the system.
            reports.generate_report: Permission to request reports for given store(s) and period of time.
            reviews.reply: Permission to reply to reviews.
            storefront.store_pause_unpause: Permission to notify the result of a pause/unpause operation, after being requested by a webhook event.
            storefront.store_availability: Permission to send the current state of store.
            storefront.store_hours_configuration: Permission to send the current store hours configuration.
            stores.manage: Permission to onboard stores and update the identifier.
            callback.error.write: Token has permission to send failed webhook event results.
            manager.loyalty: Permission to interact with loyalty services.
            direct.orders: Permission to interact with direct order services.
            store.read: Permission to query store information.
        authorizationCode:
          authorizationUrl: /v1/auth/oauth2/authorize
          tokenUrl: /v1/auth/token
          scopes:
            organization.read: Permission to read data for organization/brands/stores on behalf of a user.
            organization.service_integration: Permission to manage the your integration with a given store on behalf of a user.
x-tagGroups:
- name: Endpoints
  tags:
  - account_pairing_endpoints
  - auth_endpoints
  - callback_endpoints
  - delivery_endpoints
  - finance_endpoints
  - inventory_endpoints
  - manager_menu_endpoints
  - manager_order_endpoints
  - manager_storefront_endpoints
  - menus_endpoints
  - orders_endpoints
  - organization_endpoints
  - ping_endpoints
  - reports_endpoints
  - reviews_endpoints
  - storefront_endpoints
  - manager_loyalty_endpoints
  - direct_orders_endpoints
  - store_endpoints
- name: Webhooks
  tags:
  - account_pairing_webhooks
  - delivery_webhooks
  - manager_orders_webhooks
  - menus_webhooks
  - orders_webhooks
  - ping_webhooks
  - reports_webhooks
  - storefront_webhooks