Restful ABAP Programming Model
aplicado al ciclo de compras

@AbapCatalog.sqlViewName: 'ZIPRHEAD'
@AccessControl.authorizationCheck: #CHECK
@EndUserText.label: 'PR head — interface'
@VDM.viewType: #BASIC
@ObjectModel.semanticKey: ['ReqId']
define root view entity ZI_PR_Head
  as select from zpr_head
  composition [0..*] of ZI_PR_Item as _Item
{
  key req_id              as ReqId,
      requester           as Requester,
      plant               as Plant,
      status              as Status,
      total_estimated     as TotalEstimated,
      currency            as Currency,
      // admin
      @Semantics.user.createdBy: true
      created_by          as CreatedBy,
      @Semantics.systemDateTime.createdAt: true
      created_at          as CreatedAt,
      @Semantics.user.lastChangedBy: true
      last_changed_by     as LastChangedBy,
      @Semantics.systemDateTime.lastChangedAt: true
      last_changed_at     as LastChangedAt,
      @Semantics.systemDateTime.localInstanceLastChangedAt: true
      local_last_changed_at as LocalLastChangedAt,
      _Item
}

@UI.headerInfo: { typeName: 'Solicitud', typeNamePlural: 'Solicitudes',
                title: { value: 'ReqId' }, description: { value: 'Requester' } }
@UI.presentationVariant: [{ sortOrder: [{ by: 'ReqId', direction: #DESC }] }]
@Search.searchable: true
define root view entity ZC_PR_Head provider contract transactional_query
  as projection on ZI_PR_Head
{
      @UI.selectionField: [{ position: 10 }]
      @UI.lineItem: [{ position: 10, label: 'Solicitud' }]
      @UI.identification: [{ position: 10 }]
  key ReqId,

      @UI.lineItem: [{ position: 20, label: 'Solicitante' }]
      @UI.identification: [{ position: 20 }]
      Requester,

      @UI.lineItem: [{ position: 30, label: 'Centro' }]
      @UI.selectionField: [{ position: 20 }]
      Plant,

      @UI.lineItem: [{ position: 40, label: 'Estado',
                       criticality: 'StatusCriticality' }]
      Status,

      @UI.lineItem: [{ position: 50, label: 'Total estim.' }]
      @Semantics.amount.currencyCode: 'Currency'
      TotalEstimated,
      Currency,

      @UI.facet: [{ id: 'Items', type: #LINEITEM_REFERENCE,
                  label: 'Posiciones', targetElement: '_Item' }]
      _Item : redirected to composition child ZC_PR_Item
}

managed implementation in class zbp_i_pr_head unique;
strict ( 2 );
with draft;

define behavior for ZI_PR_Head alias PrHead
persistent table zpr_head
draft table zpr_head_d
lock master total etag LocalLastChangedAt
authorization master ( instance )
etag master LastChangedAt
{
  create;
  update;
  delete;

  field ( readonly, numbering : managed ) ReqId;
  field ( readonly ) CreatedBy, CreatedAt, LastChangedBy, LastChangedAt,
                    LocalLastChangedAt, TotalEstimated, Status;
  field ( mandatory ) Requester, Plant, Currency;

  // reglas de negocio
  validation validateHeader on save
    { create; update; }

  determination calculateTotal on modify
    { field _Item; }

  determination setStatusDraft on save
    { create; }

  // acción
  action ( features:instance, authorization:instance )
         Release result [1] $self;

  draft action Edit;
  draft action Activate optimized;
  draft action Discard;
  draft action Resume;
  draft determine action Prepare;

  // composición
  association _Item { create ( features:instance );
                       with draft; }
}

define behavior for ZI_PR_Item alias PrItem
persistent table zpr_item
draft table zpr_item_d
lock dependent by _Head
authorization dependent by _Head
{
  update;
  delete;

  field ( readonly, numbering:managed ) ReqId, ItemNo;
  field ( mandatory ) Material, Qty, Unit, UnitPrice, DeliveryDate, CostCenter;

  validation validateItem on save
    { create; update;
      field Qty, DeliveryDate, UnitPrice; }

  association _Head { with draft; }
}

CLASS lhc_prhead DEFINITION INHERITING FROM cl_abap_behavior_handler.
  PRIVATE SECTION.
    METHODS:
      validateHeader FOR VALIDATE ON SAVE
        IMPORTING keys FOR PrHead~validateHeader,

      calculateTotal FOR DETERMINE ON MODIFY
        IMPORTING keys FOR PrHead~calculateTotal,

      setStatusDraft FOR DETERMINE ON SAVE
        IMPORTING keys FOR PrHead~setStatusDraft,

      Release FOR MODIFY
        IMPORTING keys FOR ACTION PrHead~Release RESULT result.
ENDCLASS.

CLASS lhc_prhead IMPLEMENTATION.

  METHOD validateHeader.
    READ ENTITIES OF zi_pr_head IN LOCAL MODE
      ENTITY PrHead
        FIELDS ( Requester Plant Currency )
        WITH CORRESPONDING #( keys )
      RESULT DATA(heads).

    LOOP AT heads INTO DATA(ls_head).
      IF ls_head-Requester IS INITIAL
         OR ls_head-Plant IS INITIAL
         OR ls_head-Currency IS INITIAL.
        APPEND VALUE #( %tky = ls_head-%tky ) TO failed-prhead.
        APPEND VALUE #(
          %tky = ls_head-%tky
          %msg = NEW zcm_pr(
                    textid = zcm_pr=>mandatory_missing
                    severity = if_abap_behv_message=>severity-error )
        ) TO reported-prhead.
      ENDIF.
    ENDLOOP.
  ENDMETHOD.

  METHOD calculateTotal.
    READ ENTITIES OF zi_pr_head IN LOCAL MODE
      ENTITY PrHead BY \_Item
        FIELDS ( Qty UnitPrice )
        WITH CORRESPONDING #( keys )
      RESULT DATA(items)
      LINK DATA(links).

    DATA updates TYPE TABLE FOR UPDATE zi_pr_head.

    LOOP AT links INTO DATA(lk) GROUP BY lk-source-%tky.
      DATA(total) = REDUCE p( INIT s = 0
                          FOR ls IN items
                            WHERE ( ReqId = lk-source-ReqId )
                          NEXT s = s + ls-Qty * ls-UnitPrice ).

      APPEND VALUE #(
        %tky = lk-source-%tky
        TotalEstimated = total
        %control-TotalEstimated = if_abap_behv=>mk-on
      ) TO updates.
    ENDLOOP.

    MODIFY ENTITIES OF zi_pr_head IN LOCAL MODE
      ENTITY PrHead UPDATE FIELDS ( TotalEstimated )
      WITH updates.
  ENDMETHOD.

  METHOD setStatusDraft.
    MODIFY ENTITIES OF zi_pr_head IN LOCAL MODE
      ENTITY PrHead UPDATE FIELDS ( Status )
      WITH VALUE #( FOR k IN keys
        ( %tky = k-%tky Status = 'DRAFT'
          %control-Status = if_abap_behv=>mk-on ) ).
  ENDMETHOD.

  METHOD Release.
    MODIFY ENTITIES OF zi_pr_head IN LOCAL MODE
      ENTITY PrHead UPDATE FIELDS ( Status )
      WITH VALUE #( FOR k IN keys
        ( %tky = k-%tky Status = 'RELEASED'
          %control-Status = if_abap_behv=>mk-on ) ).

    READ ENTITIES OF zi_pr_head IN LOCAL MODE
      ENTITY PrHead ALL FIELDS
        WITH CORRESPONDING #( keys )
      RESULT DATA(refreshed).
    result = VALUE #( FOR ls IN refreshed
                    ( %tky = ls-%tky %param = ls ) ).
  ENDMETHOD.

ENDCLASS.

@AccessControl.authorizationCheck: #CHECK
@EndUserText.label: 'PO head — interface'
define root view entity ZI_PO_Head
  as select from zpo_head
  composition [0..*] of ZI_PO_Item as _Item
  association [0..1] to ZI_PR_Head as _PrecedingPR
    on $projection.RefPrId = _PrecedingPR.ReqId
  association [0..1] to I_Supplier as _Supplier
    on $projection.Supplier = _Supplier.Supplier
{
  key po_id           as PoId,
      supplier         as Supplier,
      currency         as Currency,
      payment_terms    as PaymentTerms,
      status           as Status,
      ref_pr_id        as RefPrId,
      total_net        as TotalNet,
      @Semantics.systemDateTime.createdAt: true
      created_at       as CreatedAt,
      @Semantics.systemDateTime.lastChangedAt: true
      last_changed_at  as LastChangedAt,
      _Item, _PrecedingPR, _Supplier
}

managed with additional save implementation in class zbp_i_po_head unique;
strict ( 2 );

define behavior for ZI_PO_Head alias PoHead
persistent table zpo_head
lock master
etag master LastChangedAt
{
  create;
  update;
  delete;

  field ( readonly, numbering:managed ) PoId;
  field ( readonly ) Status, TotalNet, CreatedAt, LastChangedAt;
  field ( mandatory ) Supplier, Currency, PaymentTerms;

  validation validateBudget on save { create; update; }
  determination setStatusOpen on save { create; }
  determination calcTotal on modify { field _Item; }

  action ( features:instance ) SendToSupplier
                                result [1] $self;
  action ( features:instance ) CancelOrder
                                result [1] $self;

  association _Item { create; }
}

CLASS lsc_po_head_saver DEFINITION INHERITING FROM
                              cl_abap_behavior_saver.
  PROTECTED SECTION.
    METHODS finalize REDEFINITION.
    METHODS adjust_numbers REDEFINITION.
ENDCLASS.

CLASS lsc_po_head_saver IMPLEMENTATION.

  METHOD finalize.
    " 1) leer todos los PO recién creados/modificados que tengan ref_pr_id
    READ ENTITIES OF zi_po_head IN LOCAL MODE
      ENTITY PoHead ALL INSTANCES
        FIELDS ( RefPrId Status )
      RESULT DATA(po_all).

    " 2) para cada PR origen, marcar status='CONVERTED'
    LOOP AT po_all INTO DATA(ls_po) WHERE RefPrId IS NOT INITIAL.
      MODIFY ENTITIES OF zi_pr_head IN LOCAL MODE
        ENTITY PrHead UPDATE FIELDS ( Status )
        WITH VALUE #( ( %tky = VALUE #( ReqId = ls_po-RefPrId )
                          Status = 'CONVERTED'
                          %control-Status = if_abap_behv=>mk-on ) ).
    ENDLOOP.
  ENDMETHOD.

  METHOD adjust_numbers.
    " Asignar PO_ID definitivos cuando la numeración es late.
    " En este caso usamos managed numbering, así que aquí no hace falta nada.
    RETURN.
  ENDMETHOD.

ENDCLASS.

METHOD SendToSupplier.
  " 1) cambiar status a SENT
  MODIFY ENTITIES OF zi_po_head IN LOCAL MODE
    ENTITY PoHead UPDATE FIELDS ( Status )
    WITH VALUE #( FOR k IN keys
      ( %tky = k-%tky Status = 'SENT'
        %control-Status = if_abap_behv=>mk-on ) ).

  " 2) publicar evento
  READ ENTITIES OF zi_po_head IN LOCAL MODE
    ENTITY PoHead ALL FIELDS
      WITH CORRESPONDING #( keys )
    RESULT DATA(refreshed).

  LOOP AT refreshed INTO DATA(ls_po).
    cl_zpo_event_pub=>publish_sent(
      iv_po_id    = ls_po-PoId
      iv_supplier = ls_po-Supplier ).
  ENDLOOP.

  result = VALUE #( FOR ls IN refreshed
                  ( %tky = ls-%tky %param = ls ) ).
ENDMETHOD.

@AccessControl.authorizationCheck: '#CHECK'
@EndUserText.label: 'GR head over MATDOC'
define root view entity ZI_GR_Head
  as select from matdoc
  association [0..1] to ZI_PO_Head as _PrecedingPO
    on $projection.RefPoId = _PrecedingPO.PoId
{
  key mblnr            as MaterialDocument,
  key mjahr            as DocumentYear,
      bldat            as DocumentDate,
      ebeln            as RefPoId,
      werks            as Plant,
      _PrecedingPO
}

unmanaged implementation in class zbp_i_gr_head unique;
strict ( 2 );

define behavior for ZI_GR_Head alias GrHead
lock master
{
  create;
  action ( features:instance ) PostGR result [1] $self;
  field ( mandatory ) RefPoId, Plant;
  field ( readonly, numbering:managed ) MaterialDocument, DocumentYear;
  validation validateAgainstPO on save { create; }
}

METHOD PostGR.
  DATA: ls_header TYPE bapi2017_gm_head_01,
        ls_code   TYPE bapi2017_gm_code,
        lt_items  TYPE TABLE OF bapi2017_gm_item_create,
        lt_return TYPE TABLE OF bapiret2,
        ls_ret    TYPE bapi2017_gm_head_ret.

  ls_code = VALUE #( gm_code = '01' ).
  ls_header = VALUE #( pstng_date = sy-datum doc_date = sy-datum ).

  CALL FUNCTION 'BAPI_GOODSMVT_CREATE'
    EXPORTING goodsmvt_header = ls_header
                goodsmvt_code   = ls_code
    IMPORTING goodsmvt_headret = ls_ret
    TABLES    goodsmvt_item    = lt_items
                return           = lt_return.

  IF line_exists( lt_return[ type = 'E' ] ).
    CALL FUNCTION 'BAPI_TRANSACTION_ROLLBACK'.
  ELSE.
    CALL FUNCTION 'BAPI_TRANSACTION_COMMIT' EXPORTING wait = 'X'.
  ENDIF.
ENDMETHOD.

@AccessControl.authorizationCheck: '#CHECK'
define root view entity ZI_Invoice_Head
  as select from zinv_head
  association [0..1] to ZI_PO_Head as _PrecedingPO
    on $projection.RefPoId = _PrecedingPO.PoId
{
  key invoice_id        as InvoiceId,
      supplier_invoice  as SupplierInvoice,
      ref_po_id         as RefPoId,
      invoice_amount    as InvoiceAmount,
      currency          as Currency,
      status            as Status,
      @UI.dataPoint: { title: 'PO total',
                       criticality: 'MatchCriticality' }
      _PrecedingPO.TotalNet  as PoTotal,
      _PrecedingPO
}

unmanaged implementation in class zbp_i_invoice_head unique;
strict ( 2 );

define behavior for ZI_Invoice_Head alias Invoice
lock master
{
  create;
  field ( mandatory ) Supplier, SupplierInvoice, InvoiceAmount, Currency;
  field ( readonly ) Status, FiDocNo;

  action ( features:instance ) PostInvoice result [1] $self;
  action ( features:instance ) Release     result [1] $self;
  validation threeWayMatch on save { create; }
}

METHOD threeWayMatch.
  READ ENTITIES OF zi_invoice_head IN LOCAL MODE
    ENTITY Invoice ALL FIELDS
      WITH CORRESPONDING #( keys )
    RESULT DATA(invs).

  LOOP AT invs INTO DATA(ls_inv).
    SELECT SUM( gr~entry_qnt * po~net_price )
      FROM mseg AS gr
      JOIN ekpo AS po
        ON gr~ebeln = po~ebeln AND gr~ebelp = po~ebelp
      WHERE gr~mblnr = @ls_inv-RefGrId AND gr~bwart = '101'
      INTO @DATA(expected).

    DATA(delta) = abs( ls_inv-InvoiceAmount - expected ).
    IF delta > expected * 0.01.
      MODIFY ENTITIES OF zi_invoice_head IN LOCAL MODE
        ENTITY Invoice UPDATE FIELDS ( Status )
        WITH VALUE #( ( %tky = ls_inv-%tky Status = 'HOLD'
                          %control-Status = if_abap_behv=>mk-on ) ).
    ENDIF.
  ENDLOOP.
ENDMETHOD.

@AccessControl.authorizationCheck: '#CHECK'
@UI.headerInfo: { typeName: 'Propuesta pago', typeNamePlural: 'Propuestas' }
define root view entity ZI_PaymentRun_Head
  provider contract transactional_query
  as select from zpay_head
  composition [0..*] of ZI_PaymentRun_Item as _Item
  association [0..1] to I_CompanyCode as _CompanyCode
    on $projection.CompanyCode = _CompanyCode.CompanyCode
{
  key run_id           as RunId,
      run_date         as RunDate,
      payment_date     as PaymentDate,
      company_code     as CompanyCode,
      status           as Status,
      @Semantics.amount.currencyCode: 'Currency'
      total_amount     as TotalAmount,
      currency         as Currency,
      created_by       as CreatedBy,
      approved_by      as ApprovedBy,
      _Item, _CompanyCode
}

define view entity ZI_PaymentRun_Item
  as select from zpay_item
  association to parent ZI_PaymentRun_Head as _Head
    on $projection.RunId = _Head.RunId
  association [1..1] to ZI_Invoice_Head as _Invoice
    on $projection.InvoiceId = _Invoice.InvoiceId
{
  key run_id, key item_no,
      supplier, invoice_id, fi_doc,
      amount, discount, net_amount,
      house_bank, payment_method, included,
      _Head, _Invoice
}

managed implementation in class zbp_i_paymentrun_head unique;
strict ( 2 );

define behavior for ZI_PaymentRun_Head alias PayRun
persistent table zpay_head
lock master
authorization master ( instance )
etag master LastChangedAt
{
  create; update; delete;

  field ( readonly, numbering:managed ) RunId;
  field ( readonly ) Status, TotalAmount, CreatedBy, ApprovedBy;
  field ( mandatory ) CompanyCode, PaymentDate, Currency;

  validation validateRunDate on save { create; update; }
  validation validateFourEyes on save { update; field ApprovedBy; }
  determination setInitialStatus on save { create; }
  determination recalcTotal      on modify { field _Item; }

  action ( features:instance ) Propose parameter ZS_ProposeParam result [1] $self;
  action ( features:instance ) Approve result [1] $self;
  action ( features:instance ) Execute result [1] $self;
  action ( features:instance ) Cancel  result [1] $self;

  event PaymentProposed parameter ZS_PaymentEventParam;
  event PaymentExecuted parameter ZS_PaymentEventParam;

  association _Item { create; }
}

METHOD Propose.
  READ ENTITIES OF zi_paymentrun_head IN LOCAL MODE
    ENTITY PayRun ALL FIELDS
      WITH CORRESPONDING #( keys )
    RESULT DATA(runs).

  LOOP AT runs INTO DATA(ls_run).

    " seleccionar facturas elegibles
    SELECT i~invoice_id, i~supplier, i~invoice_amount, i~currency,
           i~invoice_date, l~payment_method, l~house_bank,
           l~cash_disc_days, l~cash_disc_pct
      FROM zinv_head AS i
      JOIN lfb1 AS l
        ON i~supplier = l~lifnr AND l~bukrs = @ls_run-CompanyCode
      WHERE i~status = 'POSTED'
        AND i~due_date <= @ls_run-PaymentDate
        AND l~zahls = ' '
      ORDER BY i~supplier
      INTO TABLE @DATA(eligible).

    DATA items_to_create TYPE TABLE FOR CREATE zi_paymentrun_head\_Item.
    DATA n TYPE i VALUE 0.

    LOOP AT eligible INTO DATA(ls_e).
      n = n + 10.
      DATA(lv_disc) = COND p(
        WHEN ls_e-invoice_date + ls_e-cash_disc_days >= ls_run-PaymentDate
        THEN ls_e-invoice_amount * ls_e-cash_disc_pct / 100
        ELSE 0 ).

      APPEND VALUE #(
        %tky = ls_run-%tky
        %target = VALUE #(
          ( %cid     = |ITEM_{ n }|
            ItemNo   = n
            Supplier = ls_e-supplier
            InvoiceId = ls_e-invoice_id
            Amount   = ls_e-invoice_amount
            Discount = lv_disc
            NetAmount = ls_e-invoice_amount - lv_disc
            HouseBank = ls_e-house_bank
            PaymentMethod = ls_e-payment_method
            Included = abap_true ) )
      ) TO items_to_create.
    ENDLOOP.

    MODIFY ENTITIES OF zi_paymentrun_head IN LOCAL MODE
      ENTITY PayRun
        CREATE BY \_Item FIELDS
          ( ItemNo Supplier InvoiceId Amount Discount NetAmount
            HouseBank PaymentMethod Included )
        WITH items_to_create.

    MODIFY ENTITIES OF zi_paymentrun_head IN LOCAL MODE
      ENTITY PayRun UPDATE FIELDS ( Status )
      WITH VALUE #( ( %tky = ls_run-%tky Status = 'PROPOSED'
                          %control-Status = if_abap_behv=>mk-on ) ).

    RAISE ENTITY EVENT zi_paymentrun_head~PaymentProposed
      FROM VALUE #( ( %key = ls_run-%key
                      %param = VALUE #( RunId = ls_run-RunId
                                         ItemCount = lines( eligible ) ) ) ).
  ENDLOOP.
ENDMETHOD.

METHOD Execute.
  READ ENTITIES OF zi_paymentrun_head IN LOCAL MODE
    ENTITY PayRun BY \_Item ALL FIELDS
      WITH CORRESPONDING #( keys )
    RESULT DATA(items).

  DATA sepa_payments TYPE cl_dmee_facade=>tt_payments.

  LOOP AT items INTO DATA(ls_it) WHERE Included = abap_true.

    DATA doc_header TYPE bapiache09.
    DATA doc_accountap TYPE TABLE OF bapiacap09.
    DATA doc_accountgl TYPE TABLE OF bapiacgl09.
    DATA doc_currency  TYPE TABLE OF bapiaccr09.
    DATA ret TYPE TABLE OF bapiret2.
    DATA belnr TYPE belnr_d.

    doc_header = VALUE #( username = sy-uname
                          comp_code = ls_it-_Head-CompanyCode
                          doc_date = sy-datum pstng_date = sy-datum
                          doc_type = 'KZ' ).

    APPEND VALUE #( itemno_acc = 1
                     vendor_no  = ls_it-Supplier
                     gl_account = '1611000000' ) TO doc_accountap.
    APPEND VALUE #( itemno_acc = 2
                     gl_account = '1131000000'
                     hbkid = ls_it-HouseBank ) TO doc_accountgl.
    APPEND VALUE #( itemno_acc = 1
                     amt_doccur = -ls_it-NetAmount
                     currency = ls_it-_Head-Currency ) TO doc_currency.
    APPEND VALUE #( itemno_acc = 2
                     amt_doccur =  ls_it-NetAmount
                     currency = ls_it-_Head-Currency ) TO doc_currency.

    CALL FUNCTION 'BAPI_ACC_DOCUMENT_POST'
      EXPORTING documentheader = doc_header
      IMPORTING obj_key        = belnr
      TABLES    accountgl      = doc_accountgl
                  accountpayable = doc_accountap
                  currencyamount = doc_currency
                  return         = ret.

    IF line_exists( ret[ type = 'E' ] ).
      CALL FUNCTION 'BAPI_TRANSACTION_ROLLBACK'.
    ELSE.
      CALL FUNCTION 'BAPI_TRANSACTION_COMMIT' EXPORTING wait = 'X'.

      APPEND VALUE #( supplier  = ls_it-Supplier
                       amount    = ls_it-NetAmount
                       currency  = ls_it-_Head-Currency
                       iban      = cl_zpay_helper=>get_iban( ls_it-Supplier )
                       reference = |INV { ls_it-InvoiceId }| )
        TO sepa_payments.
    ENDIF.
  ENDLOOP.

  " Generación del fichero SEPA XML pain.001
  IF sepa_payments IS NOT INITIAL.
    cl_dmee_facade=>create_sepa_file(
      it_payments = sepa_payments
      iv_format   = 'SEPA_CT'
      iv_path     = |/usr/sap/Z/pay/sepa_{ sy-datum }.xml| ).
  ENDIF.

  MODIFY ENTITIES OF zi_paymentrun_head IN LOCAL MODE
    ENTITY PayRun UPDATE FIELDS ( Status )
    WITH VALUE #( FOR k IN keys
                    ( %tky = k-%tky Status = 'EXECUTED'
                      %control-Status = if_abap_behv=>mk-on ) ).

  RAISE ENTITY EVENT zi_paymentrun_head~PaymentExecuted
    FROM VALUE #( FOR k IN keys
                  ( %key = k-%key
                    %param = VALUE #( RunId = k-RunId
                                       ItemCount = lines( sepa_payments ) ) ) ).
ENDMETHOD.