Payments Object Members
See Also Overview

Public Methods

Add	Adds a new Payment object to SAP Business One company database.
Cancel	Cancels a payment transaction. The cancellation date of the transaction is the original document date.
CancelbyCurrentSystemDate	method CancelbyCurrentSystemDate
Close	Closes a record of the object in SAP Business One database.
GetApprovalTemplates	Gets the related approval template.
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.
HandleApprovalRequest	Handling of incoming payment object and received response from webservice.
Remove	Deletes a record from the object table.
RequestApproveCancellation	method RequestApproveCancellation
SaveDraftToDocument	Converts an approved draft document to a valid document.
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

AccountPayments	Returns the Payments_Accounts object that represents the payments through account transfers.
Address	Sets or returns the Bill To address of the business partner. Field name: Address. Length: 254 characters.
AllocationNumberIL	Allocation number. This field is only available in the Israel localization. Field name: AllocNum. Length: 50 characters.
ApplyVAT	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not to apply a tax to this payment. Field name: ApplyVAT.
AttachmentEntry	property AttachmentEntry
AuthorizationStatus	Returns the status of the authorization for this payment. Field name: wddStatus.
BankAccount	Sets or returns the bank account number used for this payment. Field name: BankAcct. Length: 50 characters.
BankChargeAmount	Sets or returns the bank charge amount. Field name: BcgSum.
BankChargeAmountInFC	Returns the bank charge amount in foreign currency. Field name: BcgSumFC.
BankChargeAmountInSC	Returns the bank charge amount in system currency. Field name: BcgSumSy.
BankCode	Sets or returns the bank code for bank transfer. Field name: BankCode. Length: 30 characters.
BillOfExchange	Returns the BillOfExchange object.
BillOfExchangeAgent	Sets or returns the code of the company employee responsible for the collection and management of bill of exchange transactions. Field name: BoeAgent. Length: 32 characters. This is a foreign key to the Agent Name table (OAGP), not exposed through the DI API).
BillOfExchangeAmount	Sets or returns the total amount of payment using a Bill Of Exchange document in local currency. Field name: BoeSum.
BillOfExchangeAmountFC	Returns the total amount of payment using a Bill Of Exchange document in foreign currency. Field name: BoeSumFc.
BillOfExchangeAmountSC	Returns the total amount of payment using a Bill Of Exchange document in system currency. Field name: BoeSumSc.
BillofExchangeStatus	Sets or returns a valid value of BoBoeStatus type that specifies the status of the Bill Of Exchange. Field name: BoeStatus.
BlanketAgreement	property BlanketAgreement
BoeAccount	Sets or returns the control G/L account that is used in the Bill Of Exchange transactions. Field name: BoeAcc. Length: 15 characters.
BPLID	property BPLID
BPLName	property BPLName
Browser	Returns the DataBrowser object.
Cancelled	Indicates whether the payment was cancelled.
CancelStatus	property CancelStatus
CardCode	Sets or returns the business partner code or the account code. Field name: CardCode. Length: 15 characters. This is a foreign key to the BusinessPartnersService object.
CardName	Sets or returns the business partner's full name. Field name: CardFName. Length: 100 characters.
CashAccount	Sets or returns the cash G/L account used for this payment. Field name: CashAcct. Length: 15 characters.
CashSum	Sets or returns the amount of cash in the current payment in local currency. Field name: CashSum. Mandatory property.
CashSumFC	Returns the amount of cash in the current payment in foreign currency. Field name: CashSumFC.
CashSumSys	Returns the amount of cash in the current payment in system currency. Field name: CheckSumSy.
CertificationNumber	property CertificationNumber
CheckAccount	Sets or returns the check G/L account used for this payment. Field name: CheckAcct. Length: 15 characters.
Checks	Returns the Payments_Checks child object that represents the payments through checks.
Cig	property Cig
ContactPersonCode	Sets or returns the contact person code of the specified business partner in this payment. Field name: CntctCode. This is a foreign key to the ContactEmployees object.
ControlAccount	The control account for this document. Field name: BpAct This is a foreign key to the ChartOfAccounts object.
CounterReference	Sets or returns reference information about the payment. Field name: CounterRef. Length: 8 characters.
CreditCards	Returns the Payments_CreditCards child object that represents the payments through credit cards.
Cup	property Cup
DeductionPercent	Sets or returns the deduction percentage. Field name: DdctPrcnt.
DeductionSum	Sets or returns the calculated deduction amount. Field name: DdctSum.
DigitalPayments	Indicates whether it uses digital payment. Field name: DigPayment.
DocCurrency	Sets or returns the document code of the currency used in this payment. Field name: DocCurr. Length: 3 characters.
DocDate	Sets or returns the posting date of the payment document. Field name: VatDate.
DocEntry	Returns the document entry key that uniquely identifies the payment document. Field name: DocEntry.
DocNum	Sets or returns the payment document number. Field name: DocNum.
DocObjectCode	Sets or returns a valid value of BoPaymentsObjectType type that specifies the payments document type.
DocRate	Sets or returns the exchange rate (greater than 0) related to the local currency. Field name: DocRate.
DocType	Sets or returns a valid value of BoRcptTypes type that specifies the payment recipient (replaces the DocTypte property). Field name: DocType.
DocTypte	Sets or returns a valid value of BoRcptTypes type that specifies the payment recipient.
DocumentReferences	property DocumentReferences
DueDate	Sets or returns the due date of the check. Field name: DueDate.
EDocExportFormat	Document Export Format
ElecCommMessage	Log Message
ElecCommStatus	Communication Status
ElectronicProtocols	property ElectronicProtocols
HandWritten	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not this payment is based on a handwritten document. Field name: Handwrtten.
Invoices	Returns the Payments_Invoices child object that represents the invoice data for this payment.
IsPayToBank	Sets or returns a valid value of BoYesNoEnum type that specifies whether to specify the bank details or only the PaytoCode for the outgoing payment. Field name: IsPaytoBnk.
JournalRemarks	Sets or returns the remarks to the journal entry of this payment. Field name: . Length: 50 characters.
LocalCurrency	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not the payment uses local currency. Field name: DiffCurr.
LocationCode	Sets or returns the location code in incoming and outgoing payments. Applicable for cluster B. Field name: LocCode.
PaymentByWTCertif	property PaymentByWTCertif
PaymentPriority	Sets or returns a valid value of BoPaymentPriorities type that specifies the payment priority. Field name: PaPriority.
PaymentReferenceNo	Sets or returns the number of the payment reference for the payment. Field name: PaymentRef. Length: 27 characters.
Payments_ApprovalRequests	Returns the Payments_ApprovalRequests object.
PaymentType	Sets or returns a valid value of Payment Type (Object Type). Field name: ObjType.
PayToBankAccountNo	Sets or returns the bank account number for the outgoing payment. Field name: PBnkAccnt. Length: 50 characters.
PayToBankBranch	Sets or returns the bank branch for the outgoing payment. Field name: PBnkBranch. Length: 50 characters.
PayToBankCode	Sets or returns the bank code for the outgoing payment. Field name: PBnkCode. Length: 30 characters.
PayToBankCountry	Sets or returns the bank country for the outgoing payment. Field name: PBnkCnt. Length: 3 characters. This is a foreign key to the Countries table (OCRY - not exposed through the DI API).
PayToCode	Sets or returns the destination code for the outgoing payment. Field name: PayToCode. Length: 50 characters.
PrimaryFormItems	property PrimaryFormItems
Printed	Returns a valid value of BoYesNoEnum type that specifies whether or not the payment document was printed. Field name: Printed.
PrivateKeyVersion	property PrivateKeyVersion
Proforma	Returns a valid value of BoYesNoEnum type that specifies whether or not the payment refers to a Pro-Forma invoice. Field name: Proforma.
ProjectCode	Sets or returns the project code that the payment refers to. Field name: PrjCode. Length: 8 characters. This is a foreign key to the Projects table (OPRJ - not exposed through the DI API).
Reference1	Sets or returns the first reference code of the payment. Field name: Ref1. Length: 11 characters.
Reference2	Sets or returns the second reference code of the payment. Field name: Ref2. Length: 8 characters.
Remarks	Sets or returns the remarks to this payment. Field name: Comments. Length: 254 characters.
Series	Sets or returns the auto-number series that generated the document number. Field name: Series. This is a foreign key to the Series object.
SignatureDigest	property SignatureDigest
SignatureInputMessage	property SignatureInputMessage
SplitVendorCreditRow	Splits journal entries of an outgoing payment in credit card installments.
TaxDate	Sets or returns the date for the tax calculation or payment. Field name: TaxDate.
TaxGroup	Sets or returns the VAT group. Field name: VatGroup. Length: 8 characters. This is a foreign key to the VatGroups object.
TransactionCode	Sets or returns the transaction code of incoming payment. Field name: TransCode. This is a foreign key to the Journal Entry Codes table (OTRC), not exposed through the DI API).
TransferAccount	Sets or returns the G/L account number for the payment Transfer Account. Field name: TrsfrAcct. Length: 15 characters.
TransferDate	Sets or returns the date of the payment transfer to the bank. Field name: TrsfrDate.
TransferRealAmount	Sets or returns the Transfer Real Amount in payment document. Field name: TfrRealAmt. The object is applicable for SAP Business One 2004C CEE (country-specific for Russia).
TransferReference	Sets or returns the reference information for the bank transfer payment means. Field name: TrsfrRef. Length: 27 characters.
TransferSum	Sets or returns the total payments Transfer Amount. Field name: TrsfrSum. Mandatory property.
UnderOverpaymentdifference	Sets or returns the Under / Over payment Difference. Field name: UndOvDiff.
UnderOverpaymentdiffFC	property UnderOverpaymentdiffFC
UnderOverpaymentdiffSC	Sets or returns the Under / Overpayment Difference in System Currency. Field name: UndOvDiffS.
UserFields	Returns the UserFields object.
VatDate	Sets or returns the Vat payment date (Document Date). Field name: TaxDate.
VATRegNum	property VATRegNum
WithholdingTaxCertificates	property WithholdingCertificate
WithholdingTaxDataWTX	property WithholdingTaxDataWTX
WTAccount	Returns the withholding account. Field name: WtAccount. Length: 15 characters. This is a foreign key to the ChartOfAccounts object.
WTAmount	Sets or returns the total withholding tax amount (in local currency) related to the payment. Field name: WtSum.
WTAmountFC	Returns the total withholding tax amount (in foreign currency) related to the payment. Field name: WtSumFrgn.
WTAmountSC	Returns the total withholding tax amount (in system currency) related to the payment. Field name: WtSumSys.
WtBaseSum	Sets or returns the Base sum for vat calculation. Field name: WtBaseSum.
WtBaseSumFC	Sets or returns the Withholding Tax Base Sum in Foreign Currency. Field name: WtBaseSumF.
WtBaseSumSC	Sets or returns the Withholding Tax Base Sum in System Currency. Field name: WtSumSys.
WTCode	Sets or returns the withholding tax code assigend to the payment. Length: 4 characters. This is a foreign key to WithholdingTaxCodes object. Field name: WtCode.
WTTaxableAmount	Returns the withholding taxable amount of the payment. Field name: WtBaseAmnt.

Public Methods

Public Properties

See Also