Payment

A payment [Payment] is an amount of money received from a customer against an invoice or as and advance payment (retainer).

—	XML	SOAP	REST	Database table
Object	`Payment`	`oaPayment`	—	`payment`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

Payment

oaPayment

—

payment

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

—

The Payment object has the following standard properties:

Note:

Payment object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP	Database	Description
`bulk_paymentid`	`bulk_payment_id`	The ID of the bulk_payment transaction if this payment is part of a bulk_payment.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`currency`	`currency`	Currency for the money fields in the record.
`customerid`	`customer_id`	The ID of the associated customer if this is a retainer payment.
`date`	`date`	[Required] The date of the payment. See Date Fields.
`externalid`	`external_id`	If the record was imported from an external system you store the unique external record ID here.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`invoice_number`	`invoice_number`	The associated invoice number if a payment against a specific invoice.
`invoiceid`	`invoice_id`	[Required] The associated invoice ID if a payment against a specific invoice.
`notes`	`notes`	Notes associated with the payment.
`total`	`total`	The payment total. Dated by the date field.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.

XML / SOAP

Database

Description

bulk_paymentid

bulk_payment_id

The ID of the bulk_payment transaction if this payment is part of a bulk_payment.

created

[Read-only] Time the record was created. See Date Fields.

currency

Currency for the money fields in the record.

customerid

customer_id

The ID of the associated customer if this is a retainer payment.

date

[Required] The date of the payment. See Date Fields.

externalid

external_id

If the record was imported from an external system you store the unique external record ID here.

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

invoice_number

The associated invoice number if a payment against a specific invoice.

invoiceid

invoice_id

[Required] The associated invoice ID if a payment against a specific invoice.

notes

Notes associated with the payment.

total

The payment total. Dated by the date field.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.