SAP Business One DI API 10.0 - Objects Reference (10.00.320)

• ChecksforPayment Object Members

  • Tablelist
  • DI API
  • Service Layer

  • • Public Methods

      Add	Adds a record to the object table in SAP Business One company database.
      Cancel	Not supported.
      Close	Not supported.
      GetAsXML	Returns the object from XML data, which is stored as string in a buffer.
      GetByKey	Retrieves and sets the values of the object's properties by the object's absolute key from the Company database.
      Remove	Not supported.
      SaveToFile	Save the object to a file as XML data.
      SaveXML	Saves the object data to XML formatted data.
      Update	Updates the object data in the company database.

  • • Public Properties

      AccountNumber	Sets or returns the bank account number of the check for payment. Field name: AcctNum. Length: 50 characters.
      Address	Sets or returns the mailing address of the vendor. Field name: Address. Length: 254 characters.
      AddressName	Sets or returns the name of the address (Bill To address, Main address, Ship To address, and so on). Field name: AddrName. Length: 50 characters.
      AttachmentEntry	property AttachmentEntry
      BankCode	Sets or returns the bank code of the check. Field name: BankNum. Mandatory property. Length: 30 characters.
      BankName	Returns the bank name of the payment check. Field name: BankName. Length: 15 characters.
      Branch	Sets or returns the branch number of the payment check. Field name: Branch. Length: 50 characters.
      Browser	Returns the DataBrowser object.
      Canceled	Returns a valid value of BoYesNoEnum type that specifies whether or not the check is canceled. Field name: Canceled.
      CardOrAccount	Sets 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.
      CheckAmount	Returns the total amount of the check. This number must be positive. Field name: CheckSum.
      CheckCurrency	Returns the currency of the check. SAP Business One performs a validation check. Length: 3 characters. Field name: Currency.
      CheckDate	Sets or returns the due date for the check. Field name: CheckDate.
      CheckKey	Returns the sequence number of the check for payment. Field name: CheckKey. This number is assigned by SAP Business One automatically.
      CheckNumber	Sets or returns the check number for payment. Field name: CheckNum.
      CountryCode	Sets 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).
      CreateJournalEntry	Sets 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.
      CreationDate	Returns the date of creation of the check. Field name: CreateDate.
      CustomerAccountCode	Sets or returns the credited G/L account code. Field name: CheckAcct. Mandatory property. Length: 210 characters.
      DeductionRefundAmount	Sets or returns the deduction refund amount. Field name: Deduction.
      Details	Sets or returns the journal remarks of the check for payment. Field name: Details. Length: 50 characters.
      DocumentReferences	Returns an instance of the document references of checks for payment.
      ECheck	Specifies whether the account is relevant for e-check functionality or not. Field name: ECheck.
      JournalEntryReference	Sets 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.
      Lines	Returns ChecksforPaymentLines child object.
      ManualCheck	Sets 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.
      PaymentDate	Sets 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.
      PaymentNo	Returns the payment number of the check. Field name: PmntNum.
      PrintConfirm	Confirms whether a check is printed or not. Field name: PrnConfrm.
      Printed	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not the check was printed. Field name: Printed.
      PrintedBy	Returns the ID of the user that prints the check. Field name: PrintedBy.
      PrintStatus	The column Print Status in the Check Number Confirmation window.
      Signature	Sets or returns the authorizing signature, such as the name of the responsible person, for approving the payment. Field name: Signature. Length: 30 characters.
      TaxDate	Returns the date for the tax payment. Field name: TaxDate.
      TaxTotal	Returns the total tax, such as VAT, added to the payment. Field name: VatTotal.
      TotalinWords	Sets or returns the total amount is words. SAP Business One enters this value automatically according to the CheckAmount. Field name: TotalWords. Length: 100 characters.
      TransactionNumber	Returns the transaction code that SAP Business One creates for the payment check. Field name: TransNum.
      Transferable	Sets 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.
      UpdateDate	Returns the date when the check details were last updated. Field name: UpdateDate.
      UserFields	Returns the UserFields object.
      VendorCode	Sets or returns the vendor number or G/L account for the payment. SAP Business One validates this number. Field name: VendorCode. Length: 15 characters.
      VendorName	Returns the name of the vendor that appears in the "Pay to Order of" field of the check. Field name: VendorName. Length: 100 characters.
      WithholdingTaxAmount	property WithholdingTaxAmount
      WithholdingTaxPercentage	property WithholdingTaxPercentage

  • • See Also

      ChecksforPayment Overview