AMCS Group SupplierPayment API

openapi: 3.2.0
info:
  title: Core AccessGroup Supplier Payment API
  version: core
servers:
- url: https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: SupplierPayment
paths:
  /accounting/supplierPayments/changes:
    get:
      tags:
      - SupplierPayment
      summary: Retrieve changes
      description: "| Property| Description|\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------|\n| GUID| The GUID associated to the supplier payment.|\n| Amount| Amount of the supplier payment.|\n| DateInput| The input date associated to the supplier payment.|\n| DateReceived| The received date associated to the supplier payment.|\n| IsBad| Whether the supplier payment is bad.|\n| PaymentTypeListItem| The GUID and description of the payment type associated to the supplier payment.|\n| RelatedSupplierGuid| The GUID associated to the supplier of the supplier payment. Filterable.|\n| AccountingPeriodListItem| The GUID and description of the accounting period associated to the supplier payment.|\n| APPaymentStatusListItem| The GUID and description of the AP payment status associated to the supplier payment.|\n| DateBad| The bad date associated to the supplier payment.|\n| DateBadExported| The exported bad date associated to the supplier payment.|\n| DateCleared| The cleared date associated to the supplier payment.|\n| DateExported| The exported date associated to the supplier payment.|\n| DateProcessed| The processed date associated to the supplier payment.|\n| Notes| The notes associated to the supplier payment.|\n| PayableCycleListItem| The GUID and description of the payable cycle associated to the supplier payment.|\n| PaymentPointListItem| The GUID and description of the payment point associated to the supplier payment.|\n| Reference| The referenceassociated to the supplier payment.|\n| Allocations[0]| List of supplier payment allocation made for the supplier payment.| \n| Allocations[0].Amount| Amount of the supplier payment allocation.| \n| Allocations[0].DateInput| The input date associated to the supplier payment allocation.| \n| Allocations[0].RelatedSupplierBillGuid            | The GUID associated to the supplier bill of the supplier payment.| \n| RelatedSupplierBillGuidFilter| The filter used to filter the related supplier bill guid associated to the Allocation. Filterable.|\n| IsDeleted| Supplier Payment is being deleted?|\n"
      operationId: SupplierPayment_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_ApiIntegratorSupplierPaymentResource'
  /accounting/supplierPayments/{guid}:
    get:
      tags:
      - SupplierPayment
      summary: Find with GUID
      description: "| Property| Description|\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------|\n| GUID| The GUID associated to the supplier payment.|\n| Amount| Amount of the supplier payment.|\n| DateInput| The input date associated to the supplier payment.|\n| DateReceived| The received date associated to the supplier payment.|\n| IsBad| Whether the supplier payment is bad.|\n| PaymentTypeListItem| The GUID and description of the payment type associated to the supplier payment.|\n| RelatedSupplierGuid| The GUID associated to the supplier of the supplier payment. Filterable.|\n| AccountingPeriodListItem| The GUID and description of the accounting period associated to the supplier payment.|\n| APPaymentStatusListItem| The GUID and description of the AP payment status associated to the supplier payment.|\n| DateBad| The bad date associated to the supplier payment.|\n| DateBadExported| The exported bad date associated to the supplier payment.|\n| DateCleared| The cleared date associated to the supplier payment.|\n| DateExported| The exported date associated to the supplier payment.|\n| DateProcessed| The processed date associated to the supplier payment.|\n| Notes| The notes associated to the supplier payment.|\n| PayableCycleListItem| The GUID and description of the payable cycle associated to the supplier payment.|\n| PaymentPointListItem| The GUID and description of the payment point associated to the supplier payment.|\n| Reference| The referenceassociated to the supplier payment.|\n| Allocations[0]| List of supplier payment allocation made for the supplier payment.| \n| Allocations[0].Amount| Amount of the supplier payment allocation.| \n| Allocations[0].DateInput| The input date associated to the supplier payment allocation.| \n| Allocations[0].RelatedSupplierBillGuid            | The GUID associated to the supplier bill of the supplier payment.| \n| RelatedSupplierBillGuidFilter| The filter used to filter the related supplier bill guid associated to the Allocation. Filterable.|\n| IsDeleted| Supplier Payment is being deleted?|\n"
      operationId: SupplierPayment_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_ApiIntegratorSupplierPaymentResource'
    put:
      tags:
      - SupplierPayment
      summary: Partial update
      description: "| Property| Description| Required |\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------| -------- |\n| GUID| The GUID associated to the supplier payment.| No    |\n| Amount| Amount of the supplier payment.| Yes   |\n| DateInput| The input date associated to the supplier payment.| Yes   |\n| DateReceived| The received date associated to the supplier payment.| Yes   |\n| IsBad| Whether the supplier payment is bad.| Yes   |\n| PaymentTypeListItem| The GUID and description of the payment type associated to the supplier payment.| Yes   |\n| RelatedSupplierGuid| The GUID associated to the supplier of the supplier payment. Filterable.| Yes   |\n| AccountingPeriodListItem| The GUID and description of the accounting period associated to the supplier payment.| No    |\n| APPaymentStatusListItem| The GUID and description of the AP payment status associated to the supplier payment.| No    |\n| DateBad| The bad date associated to the supplier payment.| No    |\n| DateBadExported| The exported bad date associated to the supplier payment.| No    |\n| DateCleared| The cleared date associated to the supplier payment.| No    |\n| DateExported| The exported date associated to the supplier payment.| No    |\n| DateProcessed| The processed date associated to the supplier payment.| No    |\n| Notes| The notes associated to the supplier payment.| No    |\n| PayableCycleListItem| The GUID and description of the payable cycle associated to the supplier payment.| No    |\n| PaymentPointListItem| The GUID and description of the payment point associated to the supplier payment.| No    |\n| Reference| The referenceassociated to the supplier payment.| No    |\n| Allocations[0]| List of supplier payment allocation made for the supplier payment.| No    | \n| Allocations[0].Amount| Amount of the supplier payment allocation.| Yes   | \n| Allocations[0].DateInput| The input date associated to the supplier payment allocation.| Yes   | \n| Allocations[0].RelatedSupplierBillGuid            | The GUID associated to the supplier bill of the supplier payment.| Yes   | \n| RelatedSupplierBillGuidFilter| The filter used to filter the related supplier bill guid associated to the Allocation. Filterable.| No    |\n| IsDeleted| Supplier Payment is being deleted?| No    |\n\n**Extra validations**\n\n| Condition | Error message |\n| --------- | ------------- |\n| If RelatedSupplierGuid provided is Deleted. | The provided RelatedSupplierGuid is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If PaymentTypeListItem.Guid provided is Deleted. | The provided PaymentTypeListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If AccountingPeriodListItem.Guid provided is Deleted. | The provided AccountingPeriodListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If APPaymentStatusListItem.Guid provided is Deleted. | The provided APPaymentStatusListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If PayableCycleListItem.Guid provided is Deleted. | The provided PayableCycleListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If PaymentPointListItem.Guid provided is Deleted. | The provided PaymentPointListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If RelatedSupplierBillGuid provided is Deleted. | The provided RelatedSupplierBillGuid is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If we attempt to delete a supplier payment | IsDeleted is TRUE. Could not process the request. SupplierPayment can not be deleted via the REST API. |\n| If we attempt to delete a supplier payment allocation | IsDeleted is TRUE. Could not process the request. Allocation can not be deleted via the REST API. |\n| If we provide supplier payment allocation with Guid of another supplier payment allocation | Failed to save. Allocations with Guid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx does not belong to SupplierPayment |\n| If we provide same RelatedSupplierBillGuid more than one time in allocations array | Failed to save. Allocations already exists with RelatedSupplierBillGuid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. |\n| If we provide RelatedSupplierBillGuid already exist in SupplierBillSupplierPayment(allocations) | Failed to save. SupplierBillSupplierPayment already exists with RelatedSupplierBillGuid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. |"
      operationId: SupplierPayment_Update
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiIntegratorSupplierPaymentResource'
        required: true
        x-bodyName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
  /accounting/supplierPayments:
    get:
      tags:
      - SupplierPayment
      summary: Find with Filters
      description: "| Property| Description|\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------|\n| GUID| The GUID associated to the supplier payment.|\n| Amount| Amount of the supplier payment.|\n| DateInput| The input date associated to the supplier payment.|\n| DateReceived| The received date associated to the supplier payment.|\n| IsBad| Whether the supplier payment is bad.|\n| PaymentTypeListItem| The GUID and description of the payment type associated to the supplier payment.|\n| RelatedSupplierGuid| The GUID associated to the supplier of the supplier payment. Filterable.|\n| AccountingPeriodListItem| The GUID and description of the accounting period associated to the supplier payment.|\n| APPaymentStatusListItem| The GUID and description of the AP payment status associated to the supplier payment.|\n| DateBad| The bad date associated to the supplier payment.|\n| DateBadExported| The exported bad date associated to the supplier payment.|\n| DateCleared| The cleared date associated to the supplier payment.|\n| DateExported| The exported date associated to the supplier payment.|\n| DateProcessed| The processed date associated to the supplier payment.|\n| Notes| The notes associated to the supplier payment.|\n| PayableCycleListItem| The GUID and description of the payable cycle associated to the supplier payment.|\n| PaymentPointListItem| The GUID and description of the payment point associated to the supplier payment.|\n| Reference| The referenceassociated to the supplier payment.|\n| Allocations[0]| List of supplier payment allocation made for the supplier payment.| \n| Allocations[0].Amount| Amount of the supplier payment allocation.| \n| Allocations[0].DateInput| The input date associated to the supplier payment allocation.| \n| Allocations[0].RelatedSupplierBillGuid            | The GUID associated to the supplier bill of the supplier payment.| \n| RelatedSupplierBillGuidFilter| The filter used to filter the related supplier bill guid associated to the Allocation. Filterable.|\n| IsDeleted| Supplier Payment is being deleted?|\n"
      operationId: SupplierPayment_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_ApiIntegratorSupplierPaymentResource'
    post:
      tags:
      - SupplierPayment
      summary: Create or update
      description: "| Property| Description| Required |\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------| -------- |\n| GUID| The GUID associated to the supplier payment.| No    |\n| Amount| Amount of the supplier payment.| Yes   |\n| DateInput| The input date associated to the supplier payment.| Yes   |\n| DateReceived| The received date associated to the supplier payment.| Yes   |\n| IsBad| Whether the supplier payment is bad.| Yes   |\n| PaymentTypeListItem| The GUID and description of the payment type associated to the supplier payment.| Yes   |\n| RelatedSupplierGuid| The GUID associated to the supplier of the supplier payment. Filterable.| Yes   |\n| AccountingPeriodListItem| The GUID and description of the accounting period associated to the supplier payment.| No    |\n| APPaymentStatusListItem| The GUID and description of the AP payment status associated to the supplier payment.| No    |\n| DateBad| The bad date associated to the supplier payment.| No    |\n| DateBadExported| The exported bad date associated to the supplier payment.| No    |\n| DateCleared| The cleared date associated to the supplier payment.| No    |\n| DateExported| The exported date associated to the supplier payment.| No    |\n| DateProcessed| The processed date associated to the supplier payment.| No    |\n| Notes| The notes associated to the supplier payment.| No    |\n| PayableCycleListItem| The GUID and description of the payable cycle associated to the supplier payment.| No    |\n| PaymentPointListItem| The GUID and description of the payment point associated to the supplier payment.| No    |\n| Reference| The referenceassociated to the supplier payment.| No    |\n| Allocations[0]| List of supplier payment allocation made for the supplier payment.| No    | \n| Allocations[0].Amount| Amount of the supplier payment allocation.| Yes   | \n| Allocations[0].DateInput| The input date associated to the supplier payment allocation.| Yes   | \n| Allocations[0].RelatedSupplierBillGuid            | The GUID associated to the supplier bill of the supplier payment.| Yes   | \n| RelatedSupplierBillGuidFilter| The filter used to filter the related supplier bill guid associated to the Allocation. Filterable.| No    |\n| IsDeleted| Supplier Payment is being deleted?| No    |\n\n**Extra validations**\n\n| Condition | Error message |\n| --------- | ------------- |\n| If RelatedSupplierGuid provided is Deleted. | The provided RelatedSupplierGuid is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If PaymentTypeListItem.Guid provided is Deleted. | The provided PaymentTypeListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If AccountingPeriodListItem.Guid provided is Deleted. | The provided AccountingPeriodListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If APPaymentStatusListItem.Guid provided is Deleted. | The provided APPaymentStatusListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If PayableCycleListItem.Guid provided is Deleted. | The provided PayableCycleListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If PaymentPointListItem.Guid provided is Deleted. | The provided PaymentPointListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If RelatedSupplierBillGuid provided is Deleted. | The provided RelatedSupplierBillGuid is deleted. Could not update the resource. Please check the relevant list end point for the available options. |\n| If we attempt to delete a supplier payment | IsDeleted is TRUE. Could not process the request. SupplierPayment can not be deleted via the REST API. |\n| If we attempt to delete a supplier payment allocation | IsDeleted is TRUE. Could not process the request. Allocation can not be deleted via the REST API. |\n| If we provide supplier payment allocation with Guid | One of the Allocations in the request is an update. The request could not be processed. Ensure that none of the Allocations has a guid. |\n| If we provide same RelatedSupplierBillGuid more than one time in allocations array | Failed to save. Allocations already exists with RelatedSupplierBillGuid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. |"
      operationId: SupplierPayment_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiIntegratorSupplierPaymentResource'
        required: true
        x-bodyName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
components:
  schemas:
    ApiIntegratorAllocationResource:
      type: object
      properties:
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        Amount:
          type: number
          format: double
        DateInput:
          type: string
          format: localDate
          example: '2000-01-01'
        RelatedSupplierBillGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        IsDeleted:
          type: boolean
    ApiResourceId:
      type: object
      properties:
        resource:
          type: string
          format: uuid
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceStatus:
      type: object
      properties:
        id:
          type: integer
          format: int32
        isSuccess:
          type: boolean
    ApiResourceResultEntity_ApiIntegratorSupplierPaymentResource:
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/ApiIntegratorSupplierPaymentResource'
        links:
          $ref: '#/components/schemas/ApiResourceResultEntityLinks'
        extra:
          $ref: '#/components/schemas/ApiResourceResultEntityExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    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
    ApiResourceResultUpdatesExtra:
      type: object
      properties:
        until:
          type: string
        cursor:
          type: string
    ApiIntegratorListItemResource:
      type: object
      properties:
        Description:
          type: string
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    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
    ApiResourceChanges_ApiIntegratorSupplierPaymentResource:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorSupplierPaymentResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceResultCollection_ApiIntegratorSupplierPaymentResource:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorSupplierPaymentResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiIntegratorSupplierPaymentResource:
      type: object
      properties:
        Amount:
          type: number
          format: double
        DateInput:
          type: string
          format: localDate
          example: '2000-01-01'
        DateReceived:
          type: string
          format: localDate
          example: '2000-01-01'
        IsBad:
          type: boolean
        PaymentTypeListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        RelatedSupplierGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        AccountingPeriodListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        APPaymentStatusListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        DateBad:
          type: string
          format: localDate
          example: '2000-01-01'
        DateBadExported:
          type: string
          format: localDate
          example: '2000-01-01'
        DateCleared:
          type: string
          format: localDate
          example: '2000-01-01'
        DateExported:
          type: string
          format: localDate
          example: '2000-01-01'
        DateProcessed:
          type: string
          format: localDate
          example: '2000-01-01'
        Notes:
          type: string
        PayableCycleListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        PaymentPointListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        Reference:
          type: string
        Allocations:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorAllocationResource'
        IsDeleted:
          type: boolean
        RelatedSupplierBillGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        GUID:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type: integer
          format: int32
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string