AMCS Group GLBatch API

openapi: 3.0.1
info:
  title: Core AccessGroup GLBatch API
  version: core
tags:
- name: GLBatch
paths:
  /accounting/glBatches/changes:
    get:
      tags:
      - GLBatch
      summary: Retrieve changes
      description: "| Property| Description          |\r\n| ------------------------------------- | ------------------------------------------------------------------------------- |\r\n| GUID| The guid associated to the glbatch.        |\r\n| BatchType| The batch type of the glbatch.  |  \r\n| BatchName| The batch name of the glbatch. Filterable  | \r\n| BatchStatus| The batch status of the glbatch. Filterable  | \r\n| BatchApprovalStatus| The batch approval status of the glbatch. Filterable   |\r\n| PostedDate| The posted date of the glbatch.  | \r\n| AccountingPeriodListItem| The guid and description associated to the accounting period  |\r\n| CompanyListItem| The guid and description associated to the company.  |\r\n| TransactionCount| The transaction count of the glbatch.  |\r\n| LineCount| The line count of the glbatch.  |\r\n| IsDeleted| Whether the glbatch is deleted.  |\r\n| RelatedUserCreatedByGuid| The GUID of the user who created the glbatch. Filterable  |\r\n| RelatedUserUpdatedByGuid| The GUID of the user who updated the glbatch. Filterable  |\r\n| CreationDateTime| The date of the glbatch creation.  |\r\n| UpdatedDateTime| The date of the glbatch last update.  |\r\n| FilterAccountingPeriodListItemGuid    | Filter by the accounting period guid.  |\r\n| RelatedGeneralLedgerExportGuid| The GUID of general ledger export associated to the glbatch  |"
      operationId: GLBatch_GetChanges
      parameters:
      - name: since
        in: query
        schema:
          type: string
      - name: cursor
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceChanges[ApiIntegratorGLBatchResource]'
  /accounting/glBatches/{guid}:
    get:
      tags:
      - GLBatch
      summary: Find with GUID
      description: "| Property| Description          |\r\n| ------------------------------------- | ------------------------------------------------------------------------------- |\r\n| GUID| The guid associated to the glbatch.        |\r\n| BatchType| The batch type of the glbatch.  |  \r\n| BatchName| The batch name of the glbatch. Filterable  | \r\n| BatchStatus| The batch status of the glbatch. Filterable  | \r\n| BatchApprovalStatus| The batch approval status of the glbatch. Filterable   |\r\n| PostedDate| The posted date of the glbatch.  | \r\n| AccountingPeriodListItem| The guid and description associated to the accounting period  |\r\n| CompanyListItem| The guid and description associated to the company.  |\r\n| TransactionCount| The transaction count of the glbatch.  |\r\n| LineCount| The line count of the glbatch.  |\r\n| IsDeleted| Whether the glbatch is deleted.  |\r\n| RelatedUserCreatedByGuid| The GUID of the user who created the glbatch. Filterable  |\r\n| RelatedUserUpdatedByGuid| The GUID of the user who updated the glbatch. Filterable  |\r\n| CreationDateTime| The date of the glbatch creation.  |\r\n| UpdatedDateTime| The date of the glbatch last update.  |\r\n| FilterAccountingPeriodListItemGuid    | Filter by the accounting period guid.  |\r\n| RelatedGeneralLedgerExportGuid| The GUID of general ledger export associated to the glbatch  |"
      operationId: GLBatch_Get
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultEntity[ApiIntegratorGLBatchResource]'
    put:
      tags:
      - GLBatch
      summary: Partial update
      description: "| Property                              | Description                                                                   | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID| The guid associated to the glbatch.        | Yes      |\r\n| BatchType| The batch type of the glbatch.  | Yes      |  \r\n| BatchName| The batch name of the glbatch.  | Yes      | \r\n| BatchStatus| The batch status of the glbatch.  | Yes      | \r\n| BatchApprovalStatus| The batch approval status of the glbatch.   | Yes      |\r\n| PostedDate| The posted date of the glbatch.  | No       | \r\n| AccountingPeriodListItem| The guid and description associated to the accounting period.  | Yes      |\r\n| CompanyListItem| The guid and description associated to the company.  | Yes      |\r\n| TransactionCount| The transaction count of the glbatch.  | Yes      |\r\n| LineCount| The line count of the glbatch.  | Yes      |\r\n| IsDeleted| Whether the glbatch is deleted.  | Yes      |\r\n| RelatedUserCreatedByGuid| The GUID of the user who created the glbatch.  | Yes      |\r\n| RelatedUserUpdatedByGuid| The GUID of the user who updated the glbatch.  | Yes      |\r\n| CreationDateTime| The date of the glbatch creation.  | Yes      |\r\n| UpdatedDateTime| The date of the glbatch last update.  | Yes |\r\n| FilterAccountingPeriodListItemGuid    | Filter by the accounting period guid  | No       |\r\n\r\n**Extra validations**\r\n\r\n| Condition | Error message |\r\n| --------- | ------------- |\r\n| BatchType is being edited | BatchType is a read-only property. |\r\n| BatchName is being edited | BatchName is a read-only property. |\r\n| TransactionCount is being edited | TransactionCount is a read-only property. |\r\n| LineCount is being edited | LineCount is a read-only property. |\r\n| AccountingPeriodListItem.Guid is being edited | AccountingPeriodListItem.Guid is a read-only property. |\r\n| CompanyListItem.Guid is being edited | CompanyListItem.Guid is a read-only property. |\r\n| If we attempt to delete a GLBatch | IsDeleted is TRUE. Could not process the request. Resources can not be deleted via the REST API. |\r\n| RelatedUserUpdatedByGuid is being edited | RelatedUserUpdatedByGuid is a read-only property. |\r\n| CreationDateTime is being edited | CreationDateTime is a read-only property. |\r\n| UpdatedDateTime is being edited | UpdatedDateTime is a read-only property. |"
      operationId: GLBatch_Update
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiIntegratorGLBatchResource'
        required: true
        x-bodyName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
  /accounting/glBatches:
    get:
      tags:
      - GLBatch
      summary: Find with Filters
      description: "| Property| Description          |\r\n| ------------------------------------- | ------------------------------------------------------------------------------- |\r\n| GUID| The guid associated to the glbatch.        |\r\n| BatchType| The batch type of the glbatch.  |  \r\n| BatchName| The batch name of the glbatch. Filterable  | \r\n| BatchStatus| The batch status of the glbatch. Filterable  | \r\n| BatchApprovalStatus| The batch approval status of the glbatch. Filterable   |\r\n| PostedDate| The posted date of the glbatch.  | \r\n| AccountingPeriodListItem| The guid and description associated to the accounting period  |\r\n| CompanyListItem| The guid and description associated to the company.  |\r\n| TransactionCount| The transaction count of the glbatch.  |\r\n| LineCount| The line count of the glbatch.  |\r\n| IsDeleted| Whether the glbatch is deleted.  |\r\n| RelatedUserCreatedByGuid| The GUID of the user who created the glbatch. Filterable  |\r\n| RelatedUserUpdatedByGuid| The GUID of the user who updated the glbatch. Filterable  |\r\n| CreationDateTime| The date of the glbatch creation.  |\r\n| UpdatedDateTime| The date of the glbatch last update.  |\r\n| FilterAccountingPeriodListItemGuid    | Filter by the accounting period guid.  |\r\n| RelatedGeneralLedgerExportGuid| The GUID of general ledger export associated to the glbatch  |"
      operationId: GLBatch_GetCollection
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: includeCount
        in: query
        schema:
          type: boolean
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection[ApiIntegratorGLBatchResource]'
components:
  schemas:
    ApiResourceChanges[ApiIntegratorGLBatchResource]:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorGLBatchResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiIntegratorListItemResource:
      type: object
      properties:
        Description:
          type: string
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceResultUpdatesExtra:
      type: object
      properties:
        until:
          type: string
        cursor:
          type: string
    ApiIntegratorGLBatchResource:
      type: object
      properties:
        BatchType:
          type: string
        BatchName:
          type: string
        BatchStatus:
          type: string
        BatchApprovalStatus:
          type: string
        PostedDate:
          type: string
          format: offsetDateTime
          example: '2000-01-01T00:00:00+01:00'
        AccountingPeriodListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        CompanyListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        TransactionCount:
          type: integer
          format: int32
        LineCount:
          type: integer
          format: int32
        IsDeleted:
          type: boolean
        RelatedUserCreatedByGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedUserUpdatedByGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedGeneralLedgerExportGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        CreationDateTime:
          type: string
          format: offsetDateTime
          example: '2000-01-01T00:00:00+01:00'
        UpdatedDateTime:
          type: string
          format: offsetDateTime
          example: '2000-01-01T00:00:00+01:00'
        FilterAccountingPeriodListItemGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        GUID:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceResultCollection[ApiIntegratorGLBatchResource]:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorGLBatchResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceId:
      type: object
      properties:
        resource:
          type: string
          format: uuid
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceResultEntity[ApiIntegratorGLBatchResource]:
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/ApiIntegratorGLBatchResource'
        links:
          $ref: '#/components/schemas/ApiResourceResultEntityLinks'
        extra:
          $ref: '#/components/schemas/ApiResourceResultEntityExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type: integer
          format: int32
    ApiResourceResultEntityExtra:
      type: object
      properties:
        expand:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
        include:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              additionalProperties:
                type: object
    ApiResourceResultEntityLinks:
      type: object
      properties:
        self:
          type: string
        associations:
          type: array
          items:
            type: string
        expand:
          type: array
          items:
            type: string
        operations:
          type: array
          items:
            type: string
    ApiResourceStatus:
      type: object
      properties:
        id:
          type: integer
          format: int32
        isSuccess:
          type: boolean