📚 SAP Business One SDK Help

ChecksforPayment Object Members
See Also  Overview 

Public Methods

Public Method AddAdds a record to the object table in SAP Business One company database.
Public Method CancelNot supported.
Public Method CloseNot supported.
Public Method GetAsXMLReturns the object from XML data, which is stored as string in a buffer.
Public Method GetByKeyRetrieves and sets the values of the object's properties by the object's absolute key from the Company database.
Public Method RemoveNot supported.
Public Method SaveToFileSave the object to a file as XML data.
Public Method SaveXMLSaves the object data to XML formatted data.
Public Method UpdateUpdates the object data in the company database.

Public Properties

Public Property AccountNumberSets or returns the bank account number of the check for payment.

Field name: AcctNum.

Length: 50 characters.

Public Property AddressSets or returns the mailing address of the vendor.

Field name: Address.

Length: 254 characters.

Public Property AddressNameSets or returns the name of the address (Bill To address, Main address, Ship To address, and so on).

Field name: AddrName.

Length: 50 characters.

Public Property AttachmentEntryproperty AttachmentEntry
Public Property BankCodeSets or returns the bank code of the check.

Field name: BankNum.

Mandatory property.

Length: 30 characters.

Public Property BankNameReturns the bank name of the payment check.

Field name: BankName.

Length: 15 characters.

Public Property BranchSets or returns the branch number of the payment check.

Field name: Branch.

Length: 50 characters.

Public Property BrowserReturns the DataBrowser object.
Public Property CanceledReturns a valid value of BoYesNoEnum type that specifies whether or not the check is canceled.

Field name: Canceled.

Public Property CardOrAccountSets or returns a valid value of BoCpCardAcct type that specifies whether the payment check is to a vendor card or to a G/L account.

Field name: CardOrAcct.

Public Property CheckAmountReturns the total amount of the check. This number must be positive.

Field name: CheckSum.

Public Property CheckCurrencyReturns the currency of the check. SAP Business One performs a validation check.

Length: 3 characters.

Field name: Currency.

Public Property CheckDateSets or returns the due date for the check.

Field name: CheckDate.

Public Property CheckKeyReturns the sequence number of the check for payment.

Field name: CheckKey.

This number is assigned by SAP Business One automatically.

Public Property CheckNumberSets or returns the check number for payment.

Field name: CheckNum.

Public Property CountryCodeSets or returns the country code of the bank.

Field name: CountryCod.

Mandatory property.

Length: 3 characters.

This is a foreign key to the Countries table (OCRY - not exposed through the DI API).

Public Property CreateJournalEntrySets or returns a valid value of BoYesNoEnum type that specifies whether or not to create a journal entry when adding the current check. Field name: CreateJdt.
Public Property CreationDateReturns the date of creation of the check.

Field name: CreateDate.

Public Property CustomerAccountCodeSets or returns the credited G/L account code.

Field name: CheckAcct.

Mandatory property.

Length: 210 characters.

Public Property DeductionRefundAmountSets or returns the deduction refund amount.

Field name: Deduction.

Public Property DetailsSets or returns the journal remarks of the check for payment.

Field name: Details.

Length: 50 characters.

Public Property DocumentReferencesReturns an instance of the document references of checks for payment.
Public Property ECheckSpecifies whether the account is relevant for e-check functionality or not.

Field name: ECheck.

Public Property JournalEntryReferenceSets or returns the reference number for a payment to a vendor (outgoing payment) that is already created in SAP Business One. If the reference number does not exist, SAP Business One sets the transaction key.

Field name: TransRef.

Public Property LinesReturns ChecksforPaymentLines child object.
Public Property ManualCheckSets or returns a valid value that specifies whether or not to set the check number manually. Used in case the check is not printed through SAP Business One, but written manually.

Relevant for outgoing payments only.

Public Property PaymentDateSets or returns the posting date. If you do not set this date, SAP Business One sets the current date as the posting date for the transaction.

Field name: PmntDate.

Public Property PaymentNoReturns the payment number of the check.

Field name: PmntNum.

Public Property PrintConfirmConfirms whether a check is printed or not.

Field name: PrnConfrm.

Public Property PrintedSets or returns a valid value of BoYesNoEnum type that specifies whether or not the check was printed.

Field name: Printed.

Public Property PrintedByReturns the ID of the user that prints the check.

Field name: PrintedBy.

Public Property PrintStatusThe column Print Status in the Check Number Confirmation window.
Public Property SignatureSets or returns the authorizing signature, such as the name of the responsible person, for approving the payment.

Field name: Signature.

Length: 30 characters.

Public Property TaxDateReturns the date for the tax payment.

Field name: TaxDate.

Public Property TaxTotalReturns the total tax, such as VAT, added to the payment.

Field name: VatTotal.

Public Property TotalinWordsSets or returns the total amount is words. SAP Business One enters this value automatically according to the CheckAmount.

Field name: TotalWords.

Length: 100 characters.

Public Property TransactionNumberReturns the transaction code that SAP Business One creates for the payment check.

Field name: TransNum.

Public Property TransferableSets or returns a valid value of BoYesNoEnum type that specifies whether or not the check can be endorsed. If the value is set to No (not endorsable), SAP Business One includes the text "Non-negotiable" in the printout.

Field name: Trnsfrable.

Public Property UpdateDateReturns the date when the check details were last updated.

Field name: UpdateDate.

Public Property UserFieldsReturns the UserFields object.
Public Property VendorCodeSets or returns the vendor number or G/L account for the payment. SAP Business One validates this number.

Field name: VendorCode.

Length: 15 characters.

Public Property VendorNameReturns the name of the vendor that appears in the "Pay to Order of" field of the check.

Field name: VendorName.

Length: 100 characters.

Public Property WithholdingTaxAmountproperty WithholdingTaxAmount
Public Property WithholdingTaxPercentageproperty WithholdingTaxPercentage

See Also