Recurly General Ledger Account API

openapi: 3.2.0
info:
  title: Recurly General Ledger Account API
  version: v2021-02-25
  description: 'Operations tagged General Ledger Account across 2 of this provider''s published API definitions: recurly-v3-v2021-02-25-api.yaml, recurly-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://v3.recurly.com
- url: https://v3.eu.recurly.com
security:
- api_key: []
tags:
- name: General Ledger Account
  description: 'A general ledger account is an account of record used to sort, store

    and summarize a company''s transactions. Recurly supports the balance

    sheet (Liability) account and income (Revenue) account to be attached

    to business entities, plans, or at the item level.


    When invoices are created, system can default to the accounts based

    on the GL Accounts attached at the plan/item level. The accounts can

    be defaulted from the business entity level as well.


    These accounts will be used in the Revenue Recognition module to create

    the revenue journals that can be posted into Merchant GL system.


    Revenue and Liability accounts can defined in the system using this

    API or via the General Ledger Accounting page in the Admin UI and then

    used at the plan/item level.


    Recurly allows merchants to default the accounts at the following levels:

    - Business Entities (default)

    - Plans

    - Base Price

    - Setup Fee

    - Add-ons

    - Items

    - Charges

    - Gift Cards

    - Shipping Methods

    - Credits


    If you are interested in Recurly Revenue Recognition features, please

    contact a Recurly customer service representative.'
paths:
  /general_ledger_accounts:
    post:
      tags:
      - General Ledger Account
      operationId: create_general_ledger_account
      summary: Create a new general ledger account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneralLedgerAccountCreate'
        required: true
      responses:
        '201':
          description: A new general ledger account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralLedgerAccount'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    get:
      tags:
      - General Ledger Account
      operationId: list_general_ledger_accounts
      summary: List a site's general ledger accounts
      description: See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/ids'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/sort_dates'
      - $ref: '#/components/parameters/general_ledger_account_type_enum'
      responses:
        '200':
          description: A list of the site's general ledger accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralLedgerAccountList'
        '404':
          description: Incorrect site ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
  /general_ledger_accounts/{general_ledger_account_id}:
    get:
      tags:
      - General Ledger Account
      operationId: get_general_ledger_account
      summary: Fetch a general ledger account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/general_ledger_account_id'
      responses:
        '200':
          description: A general ledger account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralLedgerAccount'
        '404':
          description: Incorrect site or general ledger account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    put:
      tags:
      - General Ledger Account
      operationId: update_general_ledger_account
      summary: Update a general ledger account
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/general_ledger_account_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneralLedgerAccountUpdate'
        required: true
      responses:
        '200':
          description: The updated general ledger account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralLedgerAccount'
        '404':
          description: Incorrect site or general ledger account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
components:
  schemas:
    GeneralLedgerAccountCreate:
      type: object
      description: Create a new liability or revenue general ledger account.
      properties:
        code:
          type: string
          title: Accounting code for the ledger account.
          description: 'Unique code to identify the ledger account. Each code must start

            with a letter or number. The following special characters are

            allowed: `-_.,:`

            '
          pattern: /^[A-Za-z0-9](( *)?[\-A-Za-z0-9_.,:])*$/
          maxLength: 255
        description:
          type: string
          title: Description
          description: Optional description.
          maxLength: 255
        account_type:
          $ref: '#/components/schemas/GeneralLedgerAccountTypeEnum'
    GeneralLedgerAccountTypeEnum:
      type: string
      enum:
      - liability
      - revenue
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    GeneralLedgerAccountList:
      type: object
      properties:
        object:
          type: string
          title: Object type
          description: Will always be List.
        has_more:
          type: boolean
          description: Indicates there are more results on subsequent pages.
        next:
          type: string
          description: Path to subsequent page of results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/GeneralLedgerAccount'
    GeneralLedgerAccount:
      type: object
      description: Full general ledger account details.
      properties:
        id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        object:
          type: string
          title: Object type
          default: general_ledger_account
          readOnly: true
        code:
          type: string
          title: Accounting code for the ledger account.
          description: 'Unique code to identify the ledger account. Each code must start

            with a letter or number. The following special characters are

            allowed: `-_.,:`

            '
          pattern: /^[A-Za-z0-9](( *)?[\-A-Za-z0-9_.,:])*$/
          maxLength: 255
        description:
          type: string
          title: Description
          description: Optional description.
          maxLength: 255
        account_type:
          $ref: '#/components/schemas/GeneralLedgerAccountTypeEnum'
        created_at:
          type: string
          format: date-time
          title: Created at
          readOnly: true
        updated_at:
          type: string
          format: date-time
          title: Last updated at
          readOnly: true
    TimestampSortEnum:
      type: string
      enum:
      - created_at
      - updated_at
    AlphanumericSortEnum:
      type: string
      enum:
      - asc
      - desc
    Error:
      type: object
      properties:
        type:
          title: Type
          $ref: '#/components/schemas/ErrorTypeEnum'
        message:
          type: string
          title: Message
        params:
          type: array
          title: Parameter specific errors
          items:
            type: object
            properties:
              param:
                type: string
    GeneralLedgerAccountUpdate:
      type: object
      description: Update an existing general ledger account.
      properties:
        code:
          type: string
          title: Accounting code for the ledger account.
          description: 'Unique code to identify the ledger account. Each code must start

            with a letter or number. The following special characters are

            allowed: `-_.,:`

            '
          pattern: /^[A-Za-z0-9](( *)?[\-A-Za-z0-9_.,:])*$/
          maxLength: 255
        description:
          type: string
          title: Description
          description: Optional description.
          maxLength: 255
    ErrorTypeEnum:
      type: string
      enum:
      - bad_request
      - immutable_subscription
      - internal_server_error
      - invalid_api_key
      - invalid_api_version
      - invalid_content_type
      - invalid_permissions
      - invalid_token
      - missing_feature
      - not_found
      - rate_limited
      - service_not_available
      - simultaneous_request
      - tax_service_error
      - transaction
      - unauthorized
      - unavailable_in_api_version
      - unknown_api_version
      - validation
  parameters:
    general_ledger_account_type_enum:
      name: account_type
      in: query
      description: General Ledger Account type by which to filter the response.
      schema:
        $ref: '#/components/schemas/GeneralLedgerAccountTypeEnum'
    accept_header:
      name: Accept
      in: header
      description: The API version to use for this request, e.g. `application/vnd.recurly.v2021-02-25`. Requests without a versioned `Accept` header return a 406 response.
      required: true
      schema:
        default: application/vnd.recurly.v2021-02-25
        $ref: '#/components/schemas/AcceptHeaderEnum'
    ids:
      name: ids
      in: query
      description: "Filter results by their IDs. Up to 200 IDs can be passed at once using\ncommas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.\n\n**Important notes:**\n\n* The `ids` parameter cannot be used with any other ordering or filtering\n  parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)\n* Invalid or unknown IDs will be ignored, so you should check that the\n  results correspond to your request.\n* Records are returned in an arbitrary order. Since results are all\n  returned at once you can sort the records yourself.\n"
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    general_ledger_account_id:
      name: general_ledger_account_id
      in: path
      description: General Ledger Account ID
      required: true
      schema:
        type: string
        title: General Ledger Account ID
        description: 'The ID of a general ledger account. General ledger accounts are

          only accessible as a part of the Recurly RevRec Standard and

          Recurly RevRec Advanced features.

          '
        maxLength: 13
    sort_dates:
      name: sort
      in: query
      description: 'Sort field. You *really* only want to sort by `updated_at` in ascending

        order. In descending order updated records will move behind the cursor and could

        prevent some records from being returned.

        '
      schema:
        default: created_at
        $ref: '#/components/schemas/TimestampSortEnum'
    order:
      name: order
      in: query
      description: Sort order.
      schema:
        default: desc
        $ref: '#/components/schemas/AlphanumericSortEnum'
    limit:
      name: limit
      in: query
      description: Limit number of records 1-200.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 20
  securitySchemes:
    api_key:
      type: http
      description: Enter the API key as the username and set the password to an empty string. You can locate and manage your API keys from the [API Credentials](https://app.recurly.com/go/developer/api_keys) page.
      scheme: basic
x-refined-from:
- recurly-v3-v2021-02-25-api.yaml
- recurly-openapi.yml
x-readme:
  explorer-enabled: false