Integrations & ERP Custom Fields / API Developer Documentation

Organizing your data for API Integration

As you begin your familiarization of the data format and API calls to prepare to integrate your AR data for YayPay, the key pieces of data and documents that YayPay uses to reflect your AR situation in the platform are summarized below.

You should work with your technical team to translate and/or map the appropriate source data from your ERP as part of deciding on the approach to bring your AR data into YayPay, to create the appropriate AR Balances and Aging display, as well as historical invoice payment data for YayPay's payment forecasts.

While the bulk of the AR data flow will originate from your ERP to YayPay, you may also want to consider retrieving payment data from YayPay to your ERP, when you use YayPay for Payments.


AR Data integrated from your ERP to YayPay

Based on the data that you send by calling different APIs, YayPay will reflect your overall AR situation, i.e. starting with your overall Company AR balance shown via the Aging Report menu in YayPay, and each Customer's balances based on the total # of Open Invoices (per Customer), etc. 

Invoices

Each Customer can have a number of Open and Closed (Paid) Invoices in YayPay. 

Invoice objects contain an array of Invoice line items, which describe the line-level details of the Invoice - the line item represents individual goods or services that the buyer purchased or was delivered, and the sum of all line item Amounts should equate to the total Invoice Amount due for collection.

Payments

This Payment Record Type contains information about the payment captured in the ERP, as well as how the Payment was applied/allocated to Invoices and/or Adjustments.

Credit Memos

Each Customer may have a number of Open Credits, which may represent a scenario of having paid more than what was owed, or stemmed from having returned a product, etc, Open Credits in YayPay may be applied/used when paying an Open Invoice. 

Adjustments

Adjustments can be any other changes to the AR ledger (e.g. Journal Entry Adjustments) that are not Invoices, Payments, or Credit Memos.

Customers Data integrated from your ERP to YayPay

Customers

This maps to the Customer Master record in your ERP. Every Customer in YayPay has a balance that will aggregate to form the Total Company AR (Total Due). Every other data object/record for YayPay (e.g. invoice, payment, credits, etc.) is then associated with the Customer. 

A hierarchical structure is also supported for Customers, so you can set up parent/child relationships in YayPay (e.g. you can enable the billing contacts of the parent company to view a consolidated balance derived from all its child companies).

Contacts

Each Customer/Account in YayPay can have 1 or multiple Contact records, where each Contact has its own email address, and can also be labeled as a Billing Contact or a Non-Billing Contact. This is located to the lower right of the Statement page, under the CONTACTS section.

This example shows a Billing Contact created in YayPay for the Customer "Brinks", and the email address brought from your ERP: 

The email addresses will be used in YayPay's Email Reminder/Workflow Automation - e.g. you can configure the Workflow to include both Billing Contacts & Non-Billing Contacts as recipients to receive email reminders from YayPay.

Other Data integrated from your ERP to YayPay

Notes

You can bring in your Collection notes recorded in your ERP and create them as Notes found under the Statement page of the Customer (i.e. Customer-level notes in YayPay). 

Customer-level and Invoice-level Custom Fields

Custom fields are used in YayPay for additional filtering, sorting on the Aging Report and Statement pages as well as in Email Templates, Workflow Custom Conditions, etc. 

An example could be functional requirements for Users to be able to work with the customer data using a Customer Group to represent different Customer segments, where the Customer Group field/values also reside in your ERP.

Configure these custom fields in YayPay (go to Settings > ERP Custom fields) to align them to the way the record is sent while calling the API to send your Customers. See this Article link also.

Invoice-level Billing Contacts

Depending on how you organize and maintain your Customer and Contact data in your ERP, you may have a need to use the concept of an Invoice-level contact, e.g. a good test would be to review your internal operations to see if a new bill/Invoice is issued to a contact that is different to the main Customer billing contact. In such situations, the contact for the Invoice can also differ from Invoice to Invoice, within the same Customer for example. 

This is termed as an Invoice-level billing contact in YayPay which should be mapped to your ERP Invoices/contacts.  The implication of not receiving such information in YayPay is that the Collection Workflows will not be able to successfully send Email Reminders to these "Invoice-level billing contact" (enabled under Workflow Settings or Global Rules respectively).

Invoice PDF 

To display, download, and/or send out your ERP-generated Invoice Document as a PDF attachment (e.g. when configuring Workflows), YayPay will need to have your Invoice document as a PDF file. 

If this file is not passed over, the Invoice PDF/Template in YayPay will be styled generically (Refer to this Article link). You should use the API called /contents to create and/or update YayPay with your Invoice PDF/Template while making reference to map to the Invoice sent through /invoices API end-point.


Next Steps - prepare an application

Refer to this Article link to prepare your application to send data to YayPay.

Can't find what you need?

Contact our support team support@yaypay.com for help.