Update or Add the Payment object and optionally make changes to any child objects.

patch

https://{server_address}/ResourceServer/api/v10/Payment/{id}

Path Params

integer

required

Unique identifier for the Payment object.

Body Params

Represents a Payment that has been made on an account.

date

date-time

Date the payment was made. Date and time values are specified in the ISO 8601 format.

amount

number

accountId

number

Unique identifier for the associated Account object.

accountName

string

The name of the object associated with the accountId property.

disbursed

boolean

paymentTypeId

number

Unique identifier for the associated PaymentType object.

paymentTypeName

string

The name of the object associated with the paymentTypeId property.

detail

string

cardTypeId

number

Unique identifier for the associated CardType object.

cardTypeName

string

The name of the object associated with the cardTypeId property.

checkNumber

string

automaticDisburse

boolean

invoiceId

number

Unique identifier for the associated Invoice object.

invoiceName

string

The name of the object associated with the invoiceId property.

posting

date-time

Date the payment should be shown as posted. Date and time values are specified in the ISO 8601 format.

baseAmount

number

invoiceAmount

number

currencyExchangeDetailId

number

Unique identifier for the associated CurrencyExchangeDetail object.

currencyExchangeDetailName

string

The name of the object associated with the currencyExchangeDetailId property.

billRunHistoryId

number

Unique identifier for the associated BillRunHistory object.

billRunHistoryName

string

The name of the object associated with the billRunHistoryId property.

isManual

boolean

reversePaymentId

number

Unique identifier for the associated Payment object.

reversePaymentName

string

The name of the object associated with the reversePaymentId property.

createdByUserId

number

Unique identifier for the associated User object.

createdByUserName

string

The name of the object associated with the createdByUserId property.

paymentMethodId

number

Unique identifier for the associated PaymentMethod object.

paymentMethodName

string

The name of the object associated with the paymentMethodId property.

paymentPreAuthorizeId

number

Unique identifier for the associated PaymentPreAuthorize object.

paymentPreAuthorizeName

string

The name of the object associated with the paymentPreAuthorizeId property.

paymentTransactionId

number

Unique identifier for the associated PaymentTransaction object.

paymentTransactionName

string

The name of the object associated with the paymentTransactionId property.

createdByPortalUserId

number

Unique identifier for the associated PortalUser object.

createdByPortalUserName

string

The name of the object associated with the createdByPortalUserId property.

paymentStatusTypeId

number

Unique identifier for the associated PaymentStatusType object.

paymentStatusTypeName

string

The name of the object associated with the paymentStatusTypeId property.

retryPaymentId

number

Unique identifier for the associated Payment object.

retryPaymentName

string

The name of the object associated with the retryPaymentId property.

isDeleted

string

deletedByUserId

string

deletedByUserName

string

paymentTransactionTypeId

number

Unique identifier for the associated PaymentTransactionType object.

paymentTransactionTypeName

string

The name of the object associated with the paymentTransactionTypeId property.

Responses

200Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.

400The request could not be processed.