Skip to content
Developerhome
Product homepage
Sage Network API

PaymentDetailModel

  Less than to read

Contains detailed information about a Payment.

Methods

The following API methods use this data model.

  • Query Payment Detail View

    Read-Only Fields

    These fields are assigned by the API server and cannot be changed.

    erpWriteStatus

ErpWriteStatuses, read-only

Possible statuses for a record that supports ERP write.

erpWriteStatusName

string, nullable, read-only

The name of the ErpWriteStatus for this payment

Required Fields

groupKey

uuid

The GroupKey uniquely identifies a single Sage Network account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

paymentId

uuid

The unique ID of this Payment.

customerId

uuid

The ID of the customer to which this Payment belongs.

paymentAmount

double

Total amount of this Payment.

unappliedAmount

double

Unapplied balance of this Payment.

baseCurrencyPaymentAmount

double

The payment amount in the group’s base currency.

baseCurrencyUnappliedAmount

double

The payment amount in the group’s base currency.

Optional Fields

customerName

string, nullable

The name of the customer to which this Payment belongs.

memoText

string, nullable

Memo or reference text (ex. memo field on a check).

referenceCode

string, nullable

Reference code for the payment for the given Erp system.

primaryContact

string, nullable

The name of the Primary Contact for the Customer.

email

string, nullable

The Email address of the Customer.

currencyCode

string, nullable, 0-3 characters

The currency code of the payment.

baseCurrencyCode

string, nullable, 0-3 characters

The base currency code of the group.

paymentType

string, nullable

The type of payment, AR Payment or AP Payment.

Recognized PaymentType values are:

  • AR Payment - A payment made by a Customer to the Company
  • AP Payment - A payment made by the Company to a Vendor

tenderType

string, nullable

Cash, check, credit card, wire transfer.

Recognized TenderType values are:

  • Cash - A cash payment or other direct transfer.
  • Check - A check payment.
  • Credit Card - A payment made via a credit card.
  • Wire Transfer - A payment made via wire transfer from another financial institution.
  • Other - A payment made via another method not listed above.

paymentDate

date, nullable

The date of this Payment.

postDate

date, nullable

Payment post date.

phone

string, nullable

The phone number of the Customer’s Primary Contact.

fax

string, nullable

The fax number of the Customer’s Primary Contact.

address1

string, nullable

The first line of the address for the Customer’s Primary Contact.

address2

string, nullable

The second line of the address for the Customer’s Primary Contact.

address3

string, nullable

The third line of the address for the Customer’s Primary Contact.

city

string, nullable

The city of the address for the Customer’s Primary Contact.

stateRegion

string, nullable

The state/region of the address for the Customer’s Primary Contact.

postalCode

string, nullable

The postal/zip code of the address for the Customer’s Primary Contact.

countryCode

string, nullable

The 2 character country code of the address for the Customer’s Primary Contact.