PaymentMandate

AuthorizationType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The type of authorization associated with the mandate. For example, whether the authorization is for the payment or disbursement requested in the mandate.

BankAccountNumber

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The account number of the bank that's used for the payment or disbursement.

BankAccountType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The type of bank account.

BankBranchAddress

• Type: address
• Properties: Filter, Nillable
• Description: The address of the bank's branch that's selected for repayment.

BankBranchName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the bank that's selected for repayment.

BankName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the bank that's selected for repayment.

BankRoutingNumber

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The sort code or routing number of the bank that's used for payment or disbursement.

CurrencyIsoCode

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: If multiple currencies are enabled, contains the currency ISO code associated with the record.

  Valid value is USD.

• Default value: USD

DisbursementAddress

• Type: address
• Properties: Filter, Nillable
• Description: The address where the disbursement check is sent.

DisbursementCity

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The city related to the disbursement address.

DisbursementCountry

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The country related to the disbursement address.

DisbursementGeocodeAccuracy

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the milestone location’s latitude and longitude coordinates.
• Possible values:
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip

DisbursementLatitude

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The latitude related to the disbursement address.

DisbursementLongitude

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The longitude related to the disbursement address.

DisbursementPostalCode

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The postal code related to the disbursement address.

DisbursementState

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The state related to the disbursement address.

DisbursementStreet

• Type: textarea
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The street related to the disbursement address.

FinancialAccountId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The financial account associated with the payment mandate.

  This field is a relationship field.

• Relationship Name: FinancialAccount
• Relationship Type: Lookup
• Refers To: FinancialAccount

IsAccountValidated

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the account is validated (true) or not (false).
• Default value: false

IsActive

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the mandate is active (true) or not (false).
• Default value: false

LastReferencedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp for when the current user last viewed this record.

MandateAmount

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The amount of the payment or disbursement requested in the mandate.

MandateEffectiveDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The start date of the mandate.

MandateEndDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The end date of the mandate.

MandateExternalIdentifier

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The external registration identifier of the mandate.

MandateFrequency

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The payment frequency for the mandate.

MandateInternalIdentifier

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The unique ID of the mandate.

MandateStatus

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The status of the mandate.

MandateSubmissionDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The date when the mandate was submitted.

MandateType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The type of mandate.

Name

• Type: string
• Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
• Description: The name of the payment mandate.

OwnerId

• Type: reference
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: The owner of the payment mandate record.

  This field is a polymorphic relationship field.

• Relationship Name: Owner
• Relationship Type: Lookup
• Refers To: Group, User

PersonAccountId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The person account that's associated with the mandate.

  This field is a relationship field.

• Relationship Name: PersonAccount
• Relationship Type: Lookup
• Refers To: Account

Ratio

• Type: percent
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The disbursement or payment percentage across bank accounts.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

paymentmandateChangeEvent

Change events are available for the object.

paymentmandateFeed

Feed tracking is available for the object.

paymentmandateHistory

History is available for tracked fields of the object.

paymentmandateShare

Sharing is available for the object.