PaymentTerm

Version: 1.33

Payment Terms are used and assigned to your Customers' BillingAccounts through the BillingAccountCategories. If you have five different Payment Terms that you want to use, you would then need at least five different Billing Account Categories, each selecting a different Payment Term. If a Payment Term is not associated through a BillingAccountCategory, then that Payment Term is not usable. Billing Account Category is called Account Category in GTV.

, PaymentTerm is queried directly through the API and is also used in BillingAccount and BillingAccountCategory.

GTV comes pre-configured with the following pre-defined Payment Terms:

  • Immediate (set as the default)

  • Net 30

The number of days defines the due date for each invoice. The calculation is the Invoice Date + Number of Days from the Payment Terms.

For example:

  • Payment Term of 10 days. Therefore:

    • Invoice Date of 9/12/2011 (+ 10 days)

    • The Invoice Due Date = 9/22/2011.

You cannot create Payment Terms through the API, only query and use them.

Perform through the UI

  • CREATE the Payment Terms (click on the following link to the GUI page for Payment Terms)

  • View the list of Payment Terms

  • Select the Payment Term

Perform through the API

  • Query and view the list of PaymentTerms

  • Select the PaymentTerm when creating a BillingAccount

  • Change the PaymentTerm on a BillingAccount

Further Gotransverse API information for this Entity of PaymentTerm:

Parameters

Each PaymentTerm shown from the query shows information for a number of Elements in the Entity. The following table shows the Elements, details of the Elements, and brief descriptions.

Elements
Element Name Query Key Element Type Field Length Description

queryScope

QueryScope

- -

Whether default query results are overridden by QueryScope resulting in SHALLOW or DEEP query results. Refer to QueryScope for details.

eid

Y

Long

System Generated

System generated unique identity number assigned to the PaymentTerm.

name

Y

String

40

The name of the PaymentTerm. Alphanumeric, free form, limit 40 characters.

termDays

Int

as needed

The number of days between the date the Invoice is produced and the Invoice Due Date which is the date your customer needs to pay the Invoice. For example, if the term days are "15" and the Invoice is produced on October 5, then the Invoice Due Date is October 20. Numeric entry, whole numbers, lowest number is "0."

graceDays

Int

as needed

The number of days between the Invoice Due Date and the date that late fees are incurred if your customer has not paid. For example, if the Invoice Due Date is October 20, and the Grace period is "3", then Late Fees are put on the Billing Account on October 24 if the Invoice is still not paid. If the Invoice is paid on October 21, 22, or 23, no Late Fees are incurred. Numeric entry, whole numbers, lowest number is "0."

The Payment Terms can be changed by your company's Administrator in Setup Payment Terms.

Entity PaymentTerms

The entity PaymentTerms enables you to see multiple pages of the entity PaymentTerm.

Elements
Element Name Element Type Field Length Description

pageNumber

Integer

as needed

Shows the current page number.

pageSize

Integer

as needed

Shows the page size.

totalElements

Long

as needed

Shows the total number of items found.

elementCount

Integer

as needed

Shows the current count of the item in the number of items that were found.

totalPages

Integer

as needed

Shows the total number of pages.

paymentTerm

PaymentTerm

- -

Shows the list of PaymentTerms.

Information for the related Entity of PaymentTerms:

  • Entity PaymentTerms

Query a Payment Term

To query for all Payment Terms, use the SimpleDataQuery with no parameters.

To query for more specific information, use the SimpleDataQuery with the parameter of one of the following Query Keys:

PaymentTerm Query Keys
Query Key Value Definition

eid

Long

The eid number of the PaymentTerm.

name

String

The name of the PaymentTerm.

billingAccountEid

Long

The eid number of the customer's BillingAccount.

billingAccountCategoryEid

Long

The eid number of the BillingAccountCategory assigned to the BillingAccount.

See All PaymentTerms

To get a list of all of your PaymentTerms without knowing the EID, name, billingAccountEid, or billingAccountCategoryEid, use the following query:

Query
Query to Use Query for Returns

SimpleDataQuery

paymentTerm

Complete list of all of the Payment Terms.

SOAP Example Query and Response

The following SOAP example is a query for all Payment Terms and shows the first 50 Payment Terms: 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:queryRequest>
                <simpleDataQuery startIndex="0" size="50">
                    <type>PaymentTerm</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

This was the response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <paymentTerms pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
                    <paymentTerm name="Immediate" termDays="0" graceDays="0" eid="406"/>
                    <paymentTerm name="Net 30" termDays="30" graceDays="0" eid="407"/>
                </paymentTerms>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Use the following endpoints for paymentTerms:

GET https://my.tractbilling.com/t/s/r/1.33/paymentTerms

GET https://my.tractbilling.com/t/s/r/1.33/paymentTerms/<eid>

GET https://my.tractbilling.com/t/s/r/1.33/paymentTerms?eid=<eid>

GET https://my.tractbilling.com/t/s/r/1.33/paymentTerms?name=<name>

GET https://my.tractbilling.com/t/s/r/1.33/paymentTerms?billingAccountEid=<billingAccountEid>

GET https://my.tractbilling.com/t/s/r/1.33/paymentTerms?billingAccountCategoryEid=<billingAccountCategoryEid>

REST Example Query and Response

The following general query provided the following response.

GET https://my.tractbilling.com/t/s/r/1.33/paymentTerms

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<paymentTerms xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
    <ns2:paymentTerm name="Immediate" termDays="0" graceDays="0" eid="406"/>
    <ns2:paymentTerm name="Net 30" termDays="30" graceDays="0" eid="407"/>
</paymentTerms>