Flipdish

Flipdish Invoices API

Operations for Invoices.

GitHub OpenAPI
Business capability
Invoicing & Statement Management BC-4250.30

Operations 4

GET /api/v1.0/{appId}/invoices/InvoicePdf Invoice pdf #
GET /api/v1.0/{appId}/invoices/ListInvoices List invoices #
GET /api/v1.0/{appId}/invoices Get invoices #
GET /api/v1.0/{appId}/invoices/ListSubscriptionInvoices List subscription invoices #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/flipdish/openapi/flipdish-invoices-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/flipdish:flipdish-invoices-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

flipdish-invoices-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flipdish Invoices API
  version: v1.0
  x-refined-note:
  - x-generated-from differs across the merged source definitions and was not carried
  - x-last-validated differs across the merged source definitions and was not carried
  description: 'Operations tagged Invoices across 2 of this provider''s published API definitions: flipdish-openapi.json, flipdish-payments-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.flipdish.co
tags:
- name: Invoices
paths:
  /api/v1.0/{appId}/invoices/InvoicePdf:
    get:
      tags:
      - Invoices
      operationId: InvoicePdf
      parameters:
      - name: invoiceNumber
        in: query
        required: true
        schema:
          type: string
      - name: appId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: NoContent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: Invoice pdf
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
  /api/v1.0/{appId}/invoices/ListInvoices:
    get:
      tags:
      - Invoices
      operationId: ListInvoices
      parameters:
      - name: storeId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: appId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
        '204':
          description: NoContent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_Invoice'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: List invoices
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
  /api/v1.0/{appId}/invoices:
    get:
      tags:
      - Invoices
      operationId: GetInvoices
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: pageId
        in: query
        required: false
        schema:
          type: string
      - name: excludeNotOwnedInvoices
        in: query
        required: false
        schema:
          type: boolean
      - name: dateFrom
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: dateTo
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: invoiceNumber
        in: query
        required: false
        schema:
          type: string
      - name: storeId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: Get invoices
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
  /api/v1.0/{appId}/invoices/ListSubscriptionInvoices:
    get:
      tags:
      - Invoices
      operationId: ListSubscriptionInvoices
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: pageId
        in: query
        required: false
        schema:
          type: string
      - name: excludeNotOwnedInvoices
        in: query
        required: false
        schema:
          type: boolean
      - name: dateFrom
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: dateTo
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: invoiceNumber
        in: query
        required: false
        schema:
          type: string
      - name: storeId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiFinanceSearchPaginationResult_SubscriptionInvoice'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: List subscription invoices
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
components:
  schemas:
    RestApiForbiddenResult:
      description: Rest Api Forbidden Result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    Invoice:
      description: Represents an ordering invoice for a period of time.
      type: object
      properties:
        InvoiceNumber:
          description: Invoice Number
          type: string
        StartDay:
          format: date-time
          description: The start day of the invoice period.
          type: string
        EndDay:
          format: date-time
          description: The end day of the invoice period.
          type: string
    RestApiFinanceSearchPaginationResult_Invoice:
      description: Rest api finance search pagination result
      required:
      - NextPage
      - Limit
      - TotalRecordCount
      - Data
      type: object
      properties:
        NextPage:
          description: Next page
          type: string
        Limit:
          format: int32
          description: Current page size
          type: integer
        TotalRecordCount:
          format: int32
          description: Total record count
          type: integer
        Data:
          description: Generic data object.
          type: array
          items:
            $ref: '#/components/schemas/Invoice'
    RestApiUnauthorizedResult:
      description: Rest api unauthorized result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    ValidationErrorResult:
      description: Validation error result
      type: object
      properties:
        FieldName:
          description: Field name
          type: string
        Errors:
          description: List of errors relates to field
          type: array
          items:
            type: string
    RestApiFinanceSearchPaginationResult_SubscriptionInvoice:
      description: Rest api finance search pagination result
      required:
      - NextPage
      - Limit
      - TotalRecordCount
      - Data
      type: object
      properties:
        NextPage:
          description: Next page
          type: string
        Limit:
          format: int32
          description: Current page size
          type: integer
        TotalRecordCount:
          format: int32
          description: Total record count
          type: integer
        Data:
          description: Generic data object.
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionInvoice'
    SubscriptionInvoice:
      description: Invoice
      required:
      - InvoiceId
      - Number
      - Currency
      - Status
      - PdfLink
      - HostedUrl
      - Overdue
      type: object
      properties:
        InvoiceId:
          description: The invoice identifier
          type: string
        Number:
          description: Invoice number
          type: string
        Total:
          format: double
          description: Total
          type: number
        Currency:
          description: Currency
          enum:
          - EUR
          - USD
          - GBP
          - CAD
          - AUD
          - DJF
          - ZAR
          - ETB
          - AED
          - BHD
          - DZD
          - EGP
          - IQD
          - JOD
          - KWD
          - LBP
          - LYD
          - MAD
          - OMR
          - QAR
          - SAR
          - SYP
          - TND
          - YER
          - CLP
          - INR
          - AZN
          - RUB
          - BYN
          - BGN
          - NGN
          - BDT
          - CNY
          - BAM
          - CZK
          - DKK
          - CHF
          - MVR
          - BTN
          - XCD
          - BZD
          - HKD
          - IDR
          - JMD
          - MYR
          - NZD
          - PHP
          - SGD
          - TTD
          - XDR
          - ARS
          - BOB
          - COP
          - CRC
          - CUP
          - DOP
          - GTQ
          - HNL
          - MXN
          - NIO
          - PAB
          - PEN
          - PYG
          - UYU
          - VEF
          - IRR
          - XOF
          - CDF
          - XAF
          - HTG
          - ILS
          - HRK
          - HUF
          - AMD
          - ISK
          - JPY
          - GEL
          - KZT
          - KHR
          - KRW
          - KGS
          - LAK
          - MKD
          - MNT
          - BND
          - MMK
          - NOK
          - NPR
          - PKR
          - PLN
          - AFN
          - BRL
          - MDL
          - RON
          - RWF
          - SEK
          - LKR
          - SOS
          - ALL
          - RSD
          - KES
          - TJS
          - THB
          - ERN
          - TMT
          - BWP
          - TRY
          - UAH
          - UZS
          - VND
          - MOP
          - TWD
          - BMD
          type: string
        Status:
          description: Status
          enum:
          - Draft
          - Open
          - Paid
          - UnCollectible
          - Void
          type: string
        SubscriptionId:
          description: The subscription identifier
          type: string
        PaidAt:
          format: date-time
          description: Paid At
          type:
          - string
          - 'null'
        FinalisedAt:
          format: date-time
          description: Finalised At
          type:
          - string
          - 'null'
        PdfLink:
          description: Pdf Link
          type: string
        HostedUrl:
          description: Hosted Url
          type: string
        Overdue:
          description: Overdue
          type: boolean
    RestApiErrorResult:
      description: Rest api error result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Error message
          type: string
        ErrorCode:
          format: int32
          description: Error code
          type: integer
        StackTrace:
          description: Stack trace
          type: string
        Errors:
          description: List of errors grouped by field name
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorResult'
    RestApiFinanceSearchPaginationResult_SubscriptionInvoice_:
      description: Rest api finance search pagination result
      required:
      - NextPage
      - Limit
      - TotalRecordCount
      - Data
      type: object
      properties:
        NextPage:
          description: Next page
          type: string
          example: string
        Limit:
          format: int32
          description: Current page size
          type: integer
          example: 1
        TotalRecordCount:
          format: int32
          description: Total record count
          type: integer
          example: 12.5
        Data:
          description: Generic data object.
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionInvoice_2'
          example: []
    Invoice_2:
      description: Represents an ordering invoice for a period of time.
      type: object
      properties:
        InvoiceNumber:
          description: Invoice Number
          type: string
          example: string
        StartDay:
          format: date-time
          description: The start day of the invoice period.
          type: string
          example: '2026-06-02T12:00:00Z'
        EndDay:
          format: date-time
          description: The end day of the invoice period.
          type: string
          example: '2026-06-02T12:00:00Z'
    RestApiFinanceSearchPaginationResult_Invoice_:
      description: Rest api finance search pagination result
      required:
      - NextPage
      - Limit
      - TotalRecordCount
      - Data
      type: object
      properties:
        NextPage:
          description: Next page
          type: string
          example: string
        Limit:
          format: int32
          description: Current page size
          type: integer
          example: 1
        TotalRecordCount:
          format: int32
          description: Total record count
          type: integer
          example: 12.5
        Data:
          description: Generic data object.
          type: array
          items:
            $ref: '#/components/schemas/Invoice_2'
          example: []
    FlipdishError:
      type: object
      description: Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).
      properties:
        error:
          type: object
          description: Error detail object.
          properties:
            errorMessage:
              type: string
              description: Descriptive explanation of the issue.
              example: Invalid or missing parameters.
            errorCode:
              type: string
              description: Unique identifier for programmatic error handling.
              example: BadRequest
            details:
              type: string
              description: Additional context returned in non-production environments.
              example: Validation failed for field 'storeId'.
    ValidationErrorResult_2:
      description: Validation error result
      type: object
      properties:
        FieldName:
          description: Field name
          type: string
          example: Example Name
        Errors:
          description: List of errors relates to field
          type: array
          items:
            type: string
          example:
          - string
    SubscriptionInvoice_2:
      description: Invoice
      required:
      - InvoiceId
      - Number
      - Currency
      - Status
      - PdfLink
      - HostedUrl
      - Overdue
      type: object
      properties:
        InvoiceId:
          description: The invoice identifier
          type: string
          example: '500123'
        Number:
          description: Invoice number
          type: string
          example: string
        Total:
          format: double
          description: Total
          type: number
          example: 12.5
        Currency:
          description: Currency
          enum:
          - EUR
          - USD
          - GBP
          - CAD
          - AUD
          - DJF
          - ZAR
          - ETB
          - AED
          - BHD
          - DZD
          - EGP
          - IQD
          - JOD
          - KWD
          - LBP
          - LYD
          - MAD
          - OMR
          - QAR
          - SAR
          - SYP
          - TND
          - YER
          - CLP
          - INR
          - AZN
          - RUB
          - BYN
          - BGN
          - NGN
          - BDT
          - CNY
          - BAM
          - CZK
          - DKK
          - CHF
          - MVR
          - BTN
          - XCD
          - BZD
          - HKD
          - IDR
          - JMD
          - MYR
          - NZD
          - PHP
          - SGD
          - TTD
          - XDR
          - ARS
          - BOB
          - COP
          - CRC
          - CUP
          - DOP
          - GTQ
          - HNL
          - MXN
          - NIO
          - PAB
          - PEN
          - PYG
          - UYU
          - VEF
          - IRR
          - XOF
          - CDF
          - XAF
          - HTG
          - ILS
          - HRK
          - HUF
          - AMD
          - ISK
          - JPY
          - GEL
          - KZT
          - KHR
          - KRW
          - KGS
          - LAK
          - MKD
          - MNT
          - BND
          - MMK
          - NOK
          - NPR
          - PKR
          - PLN
          - AFN
          - BRL
          - MDL
          - RON
          - RWF
          - SEK
          - LKR
          - SOS
          - ALL
          - RSD
          - KES
          - TJS
          - THB
          - ERN
          - TMT
          - BWP
          - TRY
          - UAH
          - UZS
          - VND
          - MOP
          - TWD
          - BMD
          type: string
          example: EUR
        Status:
          description: Status
          enum:
          - Draft
          - Open
          - Paid
          - UnCollectible
          - Void
          type: string
          example: Draft
        SubscriptionId:
          description: The subscription identifier
          type: string
          example: '500123'
        PaidAt:
          format: date-time
          description: Paid At
          type:
          - string
          - 'null'
          example: '2026-06-02T12:00:00Z'
        FinalisedAt:
          format: date-time
          description: Finalised At
          type:
          - string
          - 'null'
          example: '2026-06-02T12:00:00Z'
        PdfLink:
          description: Pdf Link
          type: string
          example: https://api.flipdish.co/example
        HostedUrl:
          description: Hosted Url
          type: string
          example: https://api.flipdish.co/example
        Overdue:
          description: Overdue
          type: boolean
          example: true
    RestApiErrorResult_2:
      description: Rest api error result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Error message
          type: string
          example: string
        ErrorCode:
          format: int32
          description: Error code
          type: integer
          example: 1
        StackTrace:
          description: Stack trace
          type: string
          example: string
        Errors:
          description: List of errors grouped by field name
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorResult_2'
          example: []
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            api: Access to Flipdish API
          authorizationUrl: https://api.flipdish.co/identity/connect/authorize
      description: OAuth2 Implicit Grant
x-refined-from:
- flipdish-openapi.json
- flipdish-payments-openapi.json