Field Name

Data Type

Required

(C = Conditional)

Notes

Payment Number

String(10)

Y

The unique payment number as assigned by the source system

CRM Payment ID

String (25)

N

This is the internal ID of the Payment  in the CRM system.

ERP Payment ID

String (25)

N

This is the internal ID of the Payment  in the ERP system.

Customer Account Number

String (50)

C

The unique customer account that is displayed on invoice. Any one of the 3 customer identifiers must be provided

CRM Customer ID

String (25)

C

This is the internal ID of the customer in the CRM system. Any one of the 3 customer identifiers must be provided

ERP Customer ID

String (25)

C

This is the internal ID of the customer in the ERP system. Any one of the 3 customer identifiers must be provided

Payment Custom Options

String (100)

N

Used for customization, leave blank unless instructed otherwise

Payment Type

Enum

Y

The status type of the payment must be one of these:

'Payment' - Money paid by Customer (positive amount)

 'Credit' - Credit given to Customer without electronic or manual transfer of funds ( -ve amount => debit or increase in balance owed by customer)

'Refund' - Money paid to Customer with actual transfer of funds (negative amount)

Amount

Money

Y

The total amount of the payment

Currency Code

String(3)

N

The 3 letter currency code. Defaults to ‘USD’

Status

Enum

Y

Must be one of:

‘Paid’ - This payment has been successfully booked (default),

‘Declined’ - The payment attempt resulted in a decline from the payment processor

'Voided' - Previously successful payment has been reversed or voided (eg: check bounced). This is only used when updating a previous payment record.

'Reversed' - If a previous payment entry is ‘Voided’, then also send a ‘Reversed’ record to perform a compensating (negative) transaction so that the net customer account balance is maintained.

‘Draft’ - Do not use, reserved for internal system.

Error - Do not use, reserved for internal system use to indicate that a payment attempt failed due to a system or network error

Effective Date

Date

Y

The posting date for the payment

Balance

Money

Y

Any unassigned balance left over after applying to the invoices against which this payment is booked. Will be 0.00 unless there is an overpayment.

Transaction Date

Date

Y

Is Processed By Billing Run

Boolean

N

Reserved for internal use

Is System Payment

Boolean

N

Set to true if this is an electronic payment (such as CC or ACH) that has been processed by eBill. For all payments that were transacted outside eBill, set this to “N” (false)

Linked Payment Number

Number

C

If the Status is ‘Reversed’ or ‘Voided” then indicates the previous payment number.

Original Payment Number

Number

C

Used if PaymentType is ‘Refund’. Indicates the original payment that has been refunded

Parent Id

Number

C

Used only for master-child payments. N/A for eBill

Payment Method Context

String(60)

N

 This field provides some loose identity about the payment instrument to enable traceability. It can be any identifying information, but do not use this to store sensitive information like credit card numbers, etc.

For eBill transacted payments, the following are used depending on the payment instrument.

CreditCard - card type, last 4 of CC# (e.g., “Visa 1234”)

 ACH - institution name, last 4 of account# (e.g., “Compass Bank 9876”)

Payment Method Type

Enum

Y

Indicates the payment method used for this transaction. Must be one of :

'CreditCard',

'ACH',

'Paypal',

'PaperCheck',

'Cash',

'HouseCredit'

'Token' - if tokenization was employed

Notes

String(100)

N

Any notes associated with the payment

Transaction Id

String(50)

N

The payment processor identifier for this transaction

Status Message

String(250)

N

Status message returned by the payment processor

Error Message

String(250)

N

Error message returned by the payment processor

Error Code

Integer

N

Numeric error code returned by the payment processor

ASV Code

String(30)

N

Status code returned by the payment processor for Address Validation Service

Cvv Code

String(30)

N

Status code returned by the payment processor for Card Verification Value (CVV)

Approval Code

String(30)

N

Approval code or secondary payment processor identifier for this transaction

Custom Field1

String (100)

N

Please contact support for custom fields.

Custom Field2

String (100)

N

Custom Field3

String (100)

N

Custom Field4

String (100)

N

Custom Field5

String (100)

N

Custom Field6

String (100)

N

Custom Field7

String (100)

N

Custom Field8

String (100)

N

Custom Field9

String (100)

N

Custom Field10

String (1000)

N

Field Name

Data Type

Required

(C = Conditional)

Notes

Record Type

String(3)

Y

Must be set to “PMI”

Update Mode

String(1)

N

U = Update

I = Insert (default)

Set to “U” to indicate this is a previously sent invoice that now needs to be updated (e.g., the invoice was adjusted or cancelled). If blank, defaults to “I’ indicating Insert.

Payment Number

String (10)

C

The unique payment number as assigned by the source system. Any one of the 3 payment identifiers must be provided

CRM Payment ID

String (25)

C

This is the internal ID of the payment in the CRM system. Any one of the 3 payment identifiers must be provided

ERP Payment ID

String (25)

C

This is the internal ID of the payment in the ERP system. Any one of the 3 payment identifiers must be provided

Invoice Number

String (10)

C

The unique invoice number. Any one of the 3 invoice identifiers must be provided

CRM Invoice ID

String (25)

C

This is the internal ID of the invoice  in the CRM system. Any one of the 3 invoice identifiers must be provided

ERP Invoice ID

String (25)

C

This is the internal ID of the invoice in the ERP system. Any one of the 3 invoice identifiers must be provided

Custom Options

String (100)

N

Used for customization, leave blank unless instructed otherwise

Amount Applied

Money

Y

The amount applied towards the indicated invoice

Balance Amount

Money

Y

The balance left over after the above amount was applied.

Custom Field1

String (100)

N

Please contact support for custom fields.

Custom Field2

String (100)

N

Custom Field3

String (100)

N

Custom Field4

String (100)

N

Custom Field5

String (100)

N