22 Accounts Receivable Invoice

This chapter includes these topics:

22.1 Accounts Receivable Invoice Overview

This chapter provides detailed information about the business interfaces that are available for the Accounts Receivable Invoice business object.

This table lists all of the available interface components:

Interface Type Available Interfaces
Business Services The ARInvoinceManager published business service (JP03B000) manages these business services:

  • ProcessARInvoiceProcessor (J03B0001), which contains the method processARInvoice.

  • ARInvoiceQueryProcessor (J03B0002), which contains the method getARInvoice.

  • ARInvoiceRevisionsQueryProcessor (J03B0003), which contains the method getARInvoiceRevisions.

  • ProcessARInvoiceRecurringInformationProcessor (J03B0004), which contains the processARInvoiceRecurringInformation method.
Real-Time Events This list includes the real-time events for the Accounts Receivable Invoice business object:

  • RTARIVOUT, which contains these single events:

    • RTARIVOUTA

    • RTARIVOUTB
Batch Import Programs This list includes the batch import programs for the Accounts Receivable Invoice business object:

  • Batch Invoice Processor program (R03B11Z1A)
Additional Interfaces The Accounts Receivable Invoice business object also uses the following business interfaces:

  • Invoice Entry MBF Processing Options (P03B0011)

    Depending on the processing option settings on the Versions tab, this program can write outbound records that can be used by an external software system.

See Setting Processing Options for Invoice Entry MBF Processing Options (P03B0011).


Note:

You can find additional technical information about each type of business interface component. For additional descriptions of the information available, and instructions for finding this information, see Chapter 5, "Accessing Additional Information for Business Interface Components."

22.2 Accounts Receivable Invoice Business Services - ARInvoiceManager

This section describes the ARInvoiceManager published business service (JP03B000), and the associated business services, which includes:

Operation Description
processARInvoice (J03B0001) Use this operation to process the AR Invoice information in the JD Edwards Enterprise One AR Management system. This operation enables you to add, change, delete/void invoices.
getARInvoice (J03B0002) Use this operation to retrieve AR information from the Enterprise One database. The operation uses the user-defined search criteria to retrieve the records.
getARInvoiceRevisions (J03B0003) Use this operation to retrieve AR revisions information from the Enterprise One database. The operation uses the user-defined search criteria to retrieve the records.

22.2.1 Accessing Javadoc for the ARInvoiceManager Web Service Operations

To access Javadoc for the ARInvoiceManager web service and its related operations, review these Javadoc packages:

  • JP03B000 (ARInvoiceManager)

  • J03B0001 (ProcessARInvoiceProcessor)

  • J03B0002 (ARInvoiceQueryProcessor)

  • J03B0003 (getARInvoiceRevisions)

22.2.2 processARInvoiceProcessor

processARInvoiceProcessor (J03B0001) is a web service operation that calls the processARInvoice method, based on the action of the user. This method enables consumers to add, change, or delete/void invoice records in the Enterprise One database.

When the processARInvoice method is called, the operation calls the BSFNs - ProcessInvoiceHeader_Wrapper (B03B1000), ProcessInvoiceDetail_Wrapper (B03B1000), ProcessGLInvoiceHeader_Wrapper (B03B1000),ProcessGLInvoiceDetail_Wrapper (B03B1000), CommitInvoice_Wrapper (B03B1000), and ARGLClearCache_Wrapper (B03B1000), to add, change, or delete/void Invoice records.

If the operation is successful, the system updates the AR invoice information in the JD Edwards Enterprise One Accounts Receivable system. If the operation encounters errors, processing stops and the errors are returned to the consumer.


Note:

Be aware of the following items when using this method:

  • GL information, with the exception of the Remark field, cannot be updated if the invoice is posted.

  • PayItem information, with the exception of the Remark field, cannot be updated if the invoice is fully-paid.

  • Correct amounts should be used when modifying the invoice amount. The system recalculates the amounts if they are sent blank.

22.2.2.1 Setup Considerations

Before you can use this operation, you can set business properties to specify how the system processes the AR Information. This table includes information about the business service properties that the processARInvoice web service operation uses:

Group Key Description Default Value
J03B0001 J03B0001_AR_GL_VERSION Use this business service property to specify the version of the Invoice Entry program that will be used while processing the data. ZJDE0001
J03B0001 J03B0001_AR_GL_VERSION Use this business service property to specify the version of the Journal Entry program that will be used while processing the data. ZJDE0001

22.2.2.2 Implementation Details

This table includes information that can help determine whether the ARInvoiceProcessor operation is functioning correctly:

Question Answer
How can I tell if the operation completes successfully? If the operation completes successfully, the system returns a confirmation message to the consumer.

The message includes all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.

At a minimum, the system returns a non-zero value for these fields:

  • documentNumber

  • documentType

  • documentCompany

  • Entity - Customer

  • batchNumber

  • payItem
If I encounter errors while process a transaction, do I need to reverse the transaction? This operation uses standard transaction processing. In the event that the operation encounters errors, all JD Edwards Enterprise One tables are returned to their original state, and no updates are performed. No manual updates are necessary.
Does this operation use record reservation? This operation reserves records in the JD Edwards Enterprise One system during the change or cancellation of an AR invoice.

22.2.3 ARInvoiceQueryProcessor

The getARInvoice (J03B0002) is a database query operation that enables consumers to retrieve and review AR Invoice records from the JD Edwards Enterprise One database. The operation returns one or more records to the consumers from the Customer Ledger (F03B11) and Account Ledger (F0911) tables that meet the specified search criteria.

22.2.3.1 Setup Considerations

Before you can use this operation, you can set business properties to specify how the system processes the invoice information. This table includes information about the business service properties that the getARInvoice web service operation uses:

Group Key Description Default Value
J03B0002 J03B0002_MAX_ROWS_F03B11 Use this business service property to specify the maximum number of AR records the operation can return for a query.

The default value is set to 100; however, this might limit the returned data when searching for AR records. If you find that limiting the number of results returned to 100 does not enable you to find the records you are searching for, it is acceptable to increase this value to a number that fits your business needs..

 100
J03B0002 J03B0002_MAX_ROWS_F0911 Use this business service property to specify the maximum number of GL records the operation can return for a query.

The default value is set to 100; however, this might limit the returned data when searching for GL Records. If you find that limiting the number of results returned to 100 does not enable you to find the GL records you are searching for, it is acceptable to increase this value to a number that fits your business needs.

 100

22.2.3.2 Implementation Details

The following table includes information that can help determine whether the ARInvoiceQueryProcessor (J03B0002) operation is functioning correctly:

Question Answer
How can I tell if the operation completes successfully? If the operation completes successfully, zero to many records are returned, based on the selection criteria.

The records that are returned to the consumer include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards Enterprise One system.

At a minimum, the system returns a non-zero value for these fields:

  • documentNumber

  • documentType

  • documentCompany

  • customerNumber

  • company

  • batchNumber

  • batchType

  • batchDate
If I encounter errors while process a transaction, do I need to reverse the transaction? This is a database query operation that does not perform transactions.

If you encounter errors during processing, review your search criteria and business service property settings and try your query again.

If the operation does not return any records, verify that records matching your query exist in the JD Edwards Enterprise One database.
Does this operation use record reservation? No. This operation does not reserve records.

22.2.4 ARInvoiceRevisionsQueryProcessor

The getARInvoiceRevisions (J03B0003) is a database query operation that enables consumers to retrieve and review AR invoice revisions records from the JD Edwards Enterprise One database. The operation returns one or more records to the consumers from the Invoice Revisions (F03B112) table that meets the specified search criteria.

22.2.4.1 Setup Considerations

Before you can use this operation, you can set business properties to specify how the system processes the AR Revisions Information. This table includes information about the business service properties that the getARInvoiceRevisions web service operation uses:

Group Key Description Default Value
J03B0003 J03B0003_MAX_ROWS_F03B112 Use this business service property to specify the maximum number of AR records the operation can return for a query.

The default value is set to 100; however, this might limit the returned data when searching for AR revision records. If you find that limiting the number of results returned to 100 does not enable you to find the records you are searching for, it is acceptable to increase this value to a number that fits your business needs..

 100

22.2.4.2 Implementation Details

The following table includes information that can help determine whether the ARInvoiceRevisionsQueryProcessor (J03B0003) operation is functioning correctly:

Question Answer
How can I tell if the operation completes successfully? If the operation completes successfully, zero to many records are returned, based on the selection criteria.

The records that are returned to the consumer include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards Enterprise One system.

At a minimum, the system returns a non-zero value for these fields:

  • documentNumber

  • documentType

  • documentCompany

  • customerNumber

  • company

  • batchNumber

  • batchType

  • batchDate

  • payItem

  • payItemExtnNumber

  • invoiceRevisionCode
If I encounter errors while process a transaction, do I need to reverse the transaction? This is a database query operation that does not perform transactions.

If you encounter errors during processing, review your search criteria and business service property settings and try your query again.

If the operation does not return any records, verify that records matching your query exist in the JD Edwards Enterprise One database.
Does this operation use record reservation? No. This operation does not reserve records.

22.2.5 ProcessARInvoiceRecurringInformationProcessor

ProcessARInvoiceRecurringInformationProcessor (J03B0004) is a web service operation that calls the processARInvoiceRecurringInformation method. This method enables consumers to change the recurring information of AR recurring invoice records in the JD Edwards Enterprise One database.

When the processARInvoiceRecurringInformation method is called, the operation calls the BSFN - ProcessInvoiceRecurringInfo (B03B1001) to change the recurring information of invoice records.

If the operation is successful, the system updates the AR invoice recurring information in the JD Edwards Enterprise One Accounts Receivable system. If the operation encounters errors, processing stops and the errors are returned to the consumer.

22.2.5.1 Implementation Details

The following table includes information that can help determine whether the ProcessARInvoiceRecurringInformationProcessor (J03B0004) operation is functioning correctly:

Question Answer
How can I tell if the operation completes successfully? If the operation completes successfully, no errors are returned to the consumer.
If I encounter errors while process a transaction, do I need to reverse the transaction? This operation uses standard transaction processing. In the event that the operation encounters errors, all JD Edwards Enterprise One tables are returned to their original state, and no updates are performed. No manual updates are necessary.
Does this operation use record reservation? No. This operation does not reserve records.

22.3 Accounts Receivable Invoice Real-Time Events

This section describes the available real-time events associated with the Accounts Receivable Invoice business object which include:

  • RTARIVOUT, which contains these single events:

    • RTARIVOUTA

    • RTARIVOUTB

22.3.1 RTARIVOUT

RTARIVOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems when an Invoice has been added, changed, or deleted in order to keep the two systems synchronized.

Event Type Event Description Event Category Event Aggregate Product Code
RTARIVOUT Accounts Receivable Invoice RTE Container

Container event for:

RTARIVOUTA (D03B1011)

RTAVIROUTB (D0901011)

 03B

Conceptual Approach

An invoice is added, modified or deleted in the JD Edwards EnterpriseOne system, which creates, modifies, or deletes a record in the Customer Ledger table (F03B11) and Account Ledger table (F0911).

Objects that Can Initiate the Event

The following objects can initiate the event, and all single events contained within the event:

  • B0000080 - Update A/R Post Status Flags

    B03B0011- Invoice Entry Master Business

    B03B0012 - F03B14 Apply Receipt to Invoice

    B03B0013 - Delete Invoice from F03B11

    B03B0015 - Void Invoice

    B03B0018 - A/R Speed Status Change

    B03B0019 - F03B13 Void/NSF Receipt

    B03B0023 - F03B14 Void/Delete Receipt

    B03B0112 - F03B21 - Write Notification Detail from Cache

    B03B0116 - F03B23 - BF Write Fee Journal

    B03B0179 - Void NSF Draft At Any Status

    N03B0077 - F03B41 - Void all Activity Records

    N03B0198 - Update A/R from Address Book

    P03B120 - Recurring Invoice Review

    P03B40 - Deduction Processing

    R15117 - Lease Global Update

    R155001 - Real Estate Management Statement

    R15903 - Priority Code Reapplication

    R15906 - Billing Detail Service/Tax Date

22.3.1.1 RTARIVOUTA

RTAVIROUTA is used by the JD Edwards EnterpriseOne system to inform third-party systems when an invoice pay item has been added, changed, or deleted in order to keep the two systems synchronized.

Event Name Event Description Event Type Event Category Product Code Data Structure Event Relationship
RTARIVOUTA AR Invoice Details RTE Single   D03B1011 - AR Inv Real Time Event Included in container event RTARIVOUT.

Conceptual Approach

An Invoice PayItem is added, modified or deleted in the JD Edwards EnterpriseOne system, which creates, modifies, or deletes a record in the Customer Ledger table (F03B11).

22.3.1.2 RTARIVOUTB

RTARIVOUTB is used by the JD Edwards EnterpriseOne system to inform third-party systems when an GL distribution line for an invoice has been added, changed, or deleted in order to keep the two systems synchronized.

Event Name Event Description Event Type Event Category Product Code Data Structure Event Relationship
RTARIVOUTB AR Invoice GL Details RTE Single   D0901011 - GL Inv Real Time Event Included in container event RTARIVOUT.

Conceptual Approach

The GL distribution line is added, modified or deleted for an invoice in the JD Edwards EnterpriseOne system, which creates, modifies, or deletes a record in the Account Ledger table (F0911).

22.4 Accounts Receivable Invoice Batch Import Programs

You use batch import programs to import data from an external software system into the JD Edwards EnterpriseOne system, where it can then be processed by EnterpriseOne programs.

This table lists and describes the available batch import programs that are associated with the Accounts Receivable Invoice business object:

Program and Program Type Description Available Documentation
Batch Invoice Processor program (R03B11Z1A).

This is a temporary table batch program.

 When you create invoices using an external system, you can transfer them to the JD Edwards EnterpriseOne Accounts Receivable system using the Batch Invoice Processor program (R03B11Z1A). See this topic: