Beacon Roofing Supply Invoiced Services API

openapi: 3.2.0
info:
  title: Beacon Rest Services (Use for Internal) Invoiced Services…
  version: 24PI-4-Sprint-3
  description: 'This version of APIs do not require the user to login, to be able to access

    services. A bearer token is required to be authorized to access the

    services.


    ### STORE BASE URL:


    [ PROD BASE URL: *https://beaconproplus.com/v4/rest/com/becn* ]


    [ UAT BASE URL: *https://beacon-uat-ng.becn.com/v4/rest/com/becn* ]


    [ DEV BASE URL: *https://beacon-dev-ng.becn.com/v4/rest/com/becn* ]


    ### IDP BASE URL:


    [ PROD BASE URL: *https://identity.becn.com/auth/realms/master/protocol/openid-connect/token* ]


    [ UAT BASE URL: *https://identity-uat.becn.com/auth/realms/master/protocol/openid-connect/token* ]


    [ DEV BASE URL: *https://identity-dev.becn.com/auth/realms/master/protocol/openid-connect/token* ]


    Key


    ## API Uniform Format:


    Show...

    ### Success Response:

    ```

    {

    "success":true,

    "messages":null,

    "result":

    }

    ```

    ### Explanation:

    If the response example value of one endpoint `/foo` is:

    ```

    {

    "name":"bar",

    "age":123

    }

    ```


    Then the actual response value of this endpoint is: (replace the value of "result" element in `API Uniform Format` with example response)

    ```

    {

    "success":true,

    "messages":null,

    "result":{

    "name":"bar",

    "age":123

    }

    }

    ```

    ### Validation Failed Response:

    ```

    {

    "success":false,

    "messages":[{

    "type": "error",

    "value": "validation exception message"

    },...],

    "result": null

    }

    ```


    ## Keycloak Authentication Process


    Show...

    ### Token endpoint

    ```

    /auth/realms/master/protocol/openid-connect/token

    ```

    The token endpoint is used to obtain tokens. Tokens can either be obtained by exchanging an authorization code or by supplying credentials directly depending on what flow is used. The token endpoint is also used to obtain new access tokens when they expire.

    ### Resource Owner Password Credentials

    Resource Owner Password Credentials, referred to as Direct Grant in {project_name}, allows exchanging user credentials for tokens.


    For a client to be permitted to use the Resource Owner Password Credentials grant the client has to have the Direct Access Grants Enabled option enabled.


    This flow is not included in OpenID Connect, but is a part of the OAuth 2.0 specification.

    ### Example for obtaining access token & refresh token using CURL

    The following example shows how to obtain an access token for a user in the realm master with username user and password password. The example is using the confidential client client_id:

    ```

    curl \

    -d "client_id=client_id" \

    -d "client_secret=client_secret" \

    -d "username=user" \

    -d "password=password" \

    -d "grant_type=password" \

    "http://{IDP_domain}/auth/realms/master/protocol/openid-connect/token"

    ```

    ### Example for obtaining access token with client credentials using CURL

    The following example shows how to obtain an access token with client credentials. The example is using the confidential client client_id:

    ```

    curl \

    -d "client_id=client_id" \

    -d "client_secret=client_secret" \

    -d "grant_type=client_credentials" \

    "http://{IDP_domain}/auth/realms/master/protocol/openid-connect/token"

    ```

    ### Example for refreshing an access token using CURL

    The following example shows how to refresh an access token with refresh token. The example is using the confidential client client_id:

    ```

    curl \

    -d "client_id=client_id" \

    -d "client_secret=client_secret" \

    -d "grant_type=refresh_token" \

    -d "refresh_token=refresh_token" \

    "http://{IDP_domain}/auth/realms/master/protocol/openid-connect/token"

    ```'
servers:
- url: https://beaconproplus.com/v2/rest/com/becn
  description: 'Production. Added by API Evangelist; the harvested document carried no servers[]. Source: internal service published on the same public Swagger index; base taken from the shared v2 prefix'
tags:
- name: Invoiced Services
paths:
  /invoice:
    get:
      tags:
      - Invoiced Services
      summary: List invoiced Data under the account
      description: This service will list the invoiced Data
      parameters:
      - in: query
        name: accountId
        description: Account ID
        required: true
        schema:
          type: string
      - in: query
        name: company
        description: Company Number
        required: true
        schema:
          type: string
      - in: query
        name: branchNumber
        description: Branch number
        required: true
        schema:
          type: string
      - in: query
        name: pageSize
        description: Default page size is 25, max 100
        schema:
          type: integer
      - in: query
        name: pageNo
        description: Default page no is 1
        schema:
          type: integer
      - in: query
        name: searchBy
        schema:
          type: string
        description: 'searchBy enumeration

          * OrderPlacedDate

          * OrderNumber

          * OrderStatus

          * UUID

          * OrderId

          '
      - in: query
        name: searchTerm
        schema:
          type: string
        description: 'When ''searchBy'' is one of the following enumeration, the ''searchTerm'' should be populated

          * OrderNumber

          * UUID

          * OrderId

          '
      - in: query
        name: searchStartDate
        schema:
          type: string
          format: MM-DD-YYYY
        description: 'When ''searchBy'' is ''OrderPlacedDate'', the ''searchStartDate'' should be populated, format should be ''MM-DD-YYYY'', e.g. ''01-05-2021'',the searchStartDate limit  to the past year.

          '
      - in: query
        name: searchEndDate
        schema:
          type: string
          format: MM-DD-YYYY
        description: 'When ''searchBy'' is ''OrderPlacedDate'', the ''searchEndDate'' should be populated, format should be ''MM-DD-YYYY'', e.g. ''01-05-2021''

          '
      - in: query
        name: searchEnum
        schema:
          type: string
        description: 'When ''searchBy'' is ''OrderStatus'', the ''searchEnum'' should be one of the following enumeration:

          * Delivered

          * Invoiced

          * Pending

          * Processing

          * ReadyDeliveryOrPickUp

          * DeliveredOrInvoiced

          '
      - in: query
        name: queryCompany
        description: Default queryCompany is true
        schema:
          type: boolean
      responses:
        '200':
          description: 'successful operation

            refer to *API Uniform Format*

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderInvoiceRep'
        '400':
          description: Bad Request, accountId is invalid
        '401':
          description: Unauthorized, the authorization bearer token is invalid
        '403':
          description: Forbidden, user do not has permission to access this API
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '419':
          description: Unauthorized, the authorization bearer token is expired
        '500':
          description: Internal exception
      operationId: getInvoice
      x-operation-id-source: derived
components:
  schemas:
    BCPaginationObj:
      type: object
      properties:
        enable:
          type: boolean
        page:
          type: integer
        currentPage:
          type: boolean
        type:
          type: string
    BCOtherPaginationObj:
      type: object
      properties:
        available:
          type: boolean
        label:
          type: string
        page:
          type: integer
    orderInvoiceRep:
      type: object
      properties:
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/orderInvoice'
        pagination:
          $ref: '#/components/schemas/BCPaginationDataObj'
    orderInvoice:
      type: object
      properties:
        apiSiteId:
          type: string
        accountId:
          type: string
        accountName:
          type: string
        orderNumber:
          type: string
        orderPlacedDate:
          type: string
          format: date
        invoiceDate:
          type: string
          format: date
        jobName:
          type: string
        jobNumber:
          type: string
        purchaseOrderNumber:
          type: string
        sales:
          type: number
          format: double
        otherCharges:
          type: number
          format: double
        salesPlusOtherCharges:
          type: number
          format: double
    BCPaginationDataObj:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/BCOtherPaginationObj'
        previous:
          $ref: '#/components/schemas/BCOtherPaginationObj'
        pageSize:
          type: integer
        currentPage:
          type: integer
        totalCount:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/BCPaginationObj'
  securitySchemes:
    internalAuth:
      type: http
      scheme: bearer
      bearerFormat: token