📚 SAP Business One SDK Help

Documents Object Members
See Also  Overview 

Public Methods

Public Method AddAdds a record to the object table in SAP Business One company database.
Public Method CancelCancels a record from the object table.
Public Method CloseCloses a record of the object in SAP Business One database.
Public Method CreateCancellationDocumentCreates a cancellation document when a marketing document is added in error, has become invalid, or has no concrete transactions associated with it.
Public Method ExportEWayBillmethod ExportEWayBill
Public Method GetApprovalTemplatesGets the related approval template.
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.

If serial numbers and batch numbers are set to the specified Document object lines, the returned object will contain references to these child objects.

Public Method HandleApprovalRequestmethod HandleApprovalRequest
Public Method RemoveNot supported.

SAP Business One does not allow to remove a document object from the database.

Note:

The remove feature is supported for Purchase Quotation.

Public Method ReopenReopens a closed document.

The method is only relevant for China, Japan, Korea, India, Brazil and Singapore.

Public Method RequestApproveCancellationmethod RequestApproveCancellation
Public Method SaveDraftToDocumentConverts an approved draft document to a valid document.
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 Method UpdateFromXMLReceives and processes the XML content.

You can remove sub-object lines from the Document object via the XML file.

Public Properties

Public Property AdditionalLegalInformationAdditional legal information text.

Field name: AddLegIn.

Length: 100 characters.

Public Property AddressThe business partner's Bill To address (sales documents) or the warehouse address (purchase documents).

If the AddressExtension property contains values for its BillTo subproperties, then the Address property value is replaced with a formatted address string based on the values in the AddressExtension property.

Field name: Address

Length: 254 characters

Public Property Address2The business partner's Ship To address.

If the AddressExtension property contains values for its ShipTo subproperties, then the Address2 property value is replaced with a formatted address string based on these values in the AddressExtension property.

Field name: Address2

Length: 254 characters

Public Property AddressExtensionThe Bill To and Ship To addresses for the document.

This property enables you to specify the BillTo and ShipTo addresses by defining their component parts -- for example, the street name, city name, and country -- instead of specifying the address as free-text strings.

After setting the AddressExtension property, the system does the following:

  1. Clears the Address and Address2 properties.
  2. Creates BillTo and ShipTo addresses based on the values in the AddressExtension property. The address format is determined by the country's address format, which is specified at Administration --> Setup --> Business Partner --> Countries. The format used is either the format for the country specified in the BillToCountry or ShipToCountry property of the AddressExtension property or, if no country is specified, the company country.
  3. Copies these addresses to the Address and Address2 properties.
Public Property AddressForReturnSub-object of address for return documents.

Field name: Address3

Length: 254 characters

Public Property AgentCodeSets or returns the code of the company employee responsible for the collection and management of bill of exchange transactions related to the business partner.

Field name: AgentCode.

Length: 32 characters.

This is a foreign key to the OAGP object.

Public Property AllocationNumberILAllocation Number (used in Electronic Invoice for Israel)
Public Property AnnualInvoiceDeclarationReferenceproperty AnnualInvoiceDeclarationReference
Public Property ApplyCurrentVATRatesForDownPaymentsToDrawproperty ApplyCurrentVATRatesForDownPaymentsToDraw
Public Property ApplyTaxOnFirstInstallmentSets or returns a valid value of BoYesNoEnum type that specifies whether or not to add the tax amount calculated in the invoice to the amount of the first installment.

Field name: VATFirst.

Public Property ArchiveNonremovableSalesQuotationIndicates whether to archive the document even when it is linked to other documents that cannot be archived. The document must still be in the archive date range and conform to all the other rules for being archived.

Applies to sales quotations only.

Field name: IgnRelDoc

Public Property AssetValueDateproperty AssetValueDate
Public Property ATDocumentTypeproperty ATDocumentType
Public Property AttachmentEntryThe attachment for marketing documents.

Field name: AtcEntry

Public Property AuthorizationCodeproperty AuthorizationCode
Public Property AuthorizationStatusReturns the status of the authorization for this payment.

Field name: wddStatus.

Public Property BaseAmountReturns the net amount (amount excluding tax, including expenses) of the document, in local currency.

Field name: BaseAmnt.

Public Property BaseAmountFCReturns the net amount (amount excluding tax, including expenses) of the document, in foreign currency.

Field name: BaseAmntFC.

Public Property BaseAmountSCReturns the net amount (amount excluding tax, including expenses) of the document, in system currency.

Field name: BaseAmntSC.

Public Property BaseEntryThe base document internal key for inventory transfer in India localization.

Field name: BaseEntry.

Public Property BaseTypeThe base document type for inventory transfer in India localization. The object code for WTR is 67.

Field name: BaseType.

Public Property BillOfExchangeReservedNot used.

Field name: BoeReserev.

Public Property BlanketAgreementNumberproperty BlanketAgreementNumber
Public Property BlockDunningSets or returns a valid value that determines wether or not to block dunning.

Field name: BlockDunn.

Sets or returns a valid value of BoYesNoEnum type that specifies whether or not to block dunning letters to the business partner.

Field name: BlockDunn.

Length: 1 character.

Public Property Box1099Default value is retrieved from Box1099 property of the BusinessPartners object.

Field name: Box1099.

Country-specific property for USA.

Sets or returns the number of Box 1099 on the Form 1099 where the payment should be entered.

Field name: Box1099.

Length: 20 characters.

Public Property BPChannelCodeSets or returns the distribution channel for the business partner (the distribution channel is also a business partner). Relevant to business partners of customer type only.

Field name: BPChCode.

Length: 15 characters.

This is a foreign key to the BusinessPartners object.

Public Property BPChannelContactSets or returns the contact person of the business partner channel.

Field name: BPChCntc.

This is a foreign key to the ContactEmployees object.

Public Property BPL_IDAssignedToInvoiceSets or returns the business place ID assigned to a marketing document (such as, invoice).

Field name: BPLId.

Public Property BPLNameproperty BPLName
Public Property BrowserReturns the DataBrowser object.
Public Property CancelDateSets or returns the cancel date of the sales order or purchase order. After this date, shipping the goods to the customer or from the vendor is not allowed.

Field name: CancelDate.

Public Property CancelledIndicates whether the document was cancelled.
Public Property CancelStatusIndicates the document cancel status.
Public Property CardCodeSets or returns the customer or vendor code.

Field name: CardCode.

This is a foreign key to the BusinessPartners object.

Sets or returns the business partner identification number in SAP Business One.

Field name: CardCode.

Length: 15 characters.

This is a foreign key to the BusinessPartners Object

Public Property CardNameSets or returns the customer or vendor name.

Field name: CardName.

Length: 100 characters.

Sets or returns the business partner's full name.

Field name: CardFName.

Length: 100 characters.

Public Property CashDiscountDateOffsetproperty CashDiscountDateOffset
Public Property CentralBankIndicatorSets or returns the central bank indicator for foreign documents as defined in SAP Business One.

Field name: CntrlBnk.

Length: 15 characters.

This is a foreign key to the Central Bank Ind. object (OCBI), not exposed through the DI API)

Public Property CertificationNumberproperty CertificationNumber
Public Property Cigproperty Cig
Public Property ClosingDateSet or retrieves Document closing date.

Field name: ClsDate.

Public Property ClosingOptionTo close a goods receipt PO or a goods return, specify a posting date to be used in the clearing journal entry.

Field: ClosingOpt.

Public Property ClosingRemarksSets or returns the Footer text of the sales or purchasing document.

Field name: Footer.

Length: 64000 characters.

Public Property CommentsSets or returns comments for the document.

Field name: Comments.

Length: 254 characters.

Public Property CommissionTradeproperty CommissionTrade
Public Property CommissionTradeReturnproperty CommissionTradeReturn
Public Property ConfirmedSets or returns a valid value of BoYesNoEnum type that specifies whether or not this document is confirmed. The information of confirmed documents can be used as a basis for creating other documents (such as invoices).

Field name: Confirmed.

Public Property ContactPersonCodeSets or returns the Contact Person code.

Field name: CntctCode.

This is a foreign key to the ContactEmployees object.

Public Property ControlAccountThe control account for this document.

Field name: CtlAccount

This is a foreign key to the ChartOfAccounts object.

Public Property CreateOnlineQuotationproperty CreateOnlineQuotation
Public Property CreateQRCodeFromproperty CreateQRCodeFrom
Public Property CreationDateReturns the creation date of the document.

Field name: CreateDate.

Public Property Cupproperty Cup
Public Property CustOfficeEnter Customs Office Name. It is mandatory if Export Process form is filled in..

Field name: CustOffice.

Length: 60 characters.

Public Property DANFELegalTextDANFE Legal Text.

Field name: DANFELgTxt.

Public Property DateOfReportingControlStatementVATproperty DateOfReportingControlStatementVAT
Public Property DeferredTaxSets or returns a valid value of BoYesNoEnum type that specifies whether or not the business partner applies deferred tax.

Field name: DeferrTax.

Length: 1 characters.

Public Property DigitalPaymentsIndicates whether it uses digital payment.

Field name: DigPayment.

Public Property DigitalPayToAddressThe pay-to address of the digital payment.

Field name: DPayToAddr.

Length: 50 characters.

Public Property DiscountPercentSets or returns the discount percentage you specify for a customer, or the discount percentage a supplier specifies for you.

Field name: Discount.

Public Property DocCurrencySets or returns the currency used in the document.

Field name: DocCur.

Length: 3 characters.

This is a foreign key to the Currencies object.

Public Property DocDateSets or returns the document posting date.

Field name: DocDate.

Public Property DocDueDateSets or returns the document due date (for example, Delivery Date in sales orders, Value Date in invoices, Valid To in quotations, and so on).

Field name: DocDueDate.

Public Property DocEntryReturns the document entry key that uniquely identifies the document.

Field name: DocEntry.

Public Property DocNumSets or returns the number of the document.Mandatory field in SAP Business One only in case the value of the HandWritten property is tYES.

Field name: DocNum.

and also verify Relevant to sales documents only.

In case the value of the HandWritten property is tNO and you add a sales document, SAP Business One automatically assigns the next available number to the document, in accordance with the document numbering system defined during system configuration.

When saving the document as a draft, this number is stored for the document draft only. So that the number of the draft is still available in the system for other new documents. The system may assign this number to a new document of the same type. When saving the draft as a document, SAP Business One assigns a new available number.

In case the value of the HandWritten property is tYES, set a value (greater than 0) to the DocNum property and also set the Series property to -1.

Public Property DocObjectCodeSets or returns a valid value of BoObjectTypes type that specifies the object type related to a draft document.

Note: This property is replaced by DocObjectCodeEx property (string), but remains in the collection due to backward compatibility.

Public Property DocObjectCodeExSets or returns the a valid value of BoObjectTypes that defines the document object code (replaces the valid values of DocObjectCode property).
Public Property DocRateSets or returns the exchange rate with local currency for the document.

Field name: DocRate.

Public Property DocTimeSets or returns the document creation time.

Field name: DocTime.

Public Property DocTotalSets or returns the total amount in the document.

Field name: DocTotal.

Public Property DocTotalFcSets or returns the total amount, in foreign currency, in the document.

Field name: DocTotalFC.

Public Property DocTotalSysSets or returns the total amount, in system currency, in the document.

Field name: DocTotalSy.

Public Property DocTypeSets or returns a valid value of BoDocumentTypes type that specifies the business transaction content type: Items Transaction or Service Transaction.

Field name: DocType.

Public Property Document_ApprovalRequestsReturns the Document_ApprovalRequests object.
Public Property DocumentDeliveryProperty DocumentDelivery
Public Property DocumentReferencesproperty DocumentReferences
Public Property DocumentsOwnerSets or returns the document owner.

Field name: OwnerCode.

This is a foreign key to the EmployeesInfo object.

Public Property DocumentStatusReturns a valid value of BoStatus type that specifies document status (closed or open).

Field name: DocStatus.

Public Property DocumentSubTypeSets or returns a valid value of BoDocumentSubType type that specifies document sub-type.

Field name: DocSubType.

Public Property DocumentTaxIDproperty DocumentTaxID
Public Property DownPaymentDeprecated in Release 2006 A.

Instead, use the properties DownPaymentAmount, DownPaymentAmountFC, DownPaymentAmountSC.

Public Property DownPaymentAmountReturns the total down payment amount in local currency.

Field name: DpmAmnt.

Public Property DownPaymentAmountFCReturns the total down payment amount in foreign currency.

Field name: DpmAmntFC.

Public Property DownPaymentAmountSCReturns the total down payment amount in system currency.

Field name: DpmAmntSC.

Public Property DownPaymentPercentageSets or returns percentage of down payment.

Field name: DpmPrcnt.

Public Property DownPaymentStatusproperty DownPaymentStatus
Public Property DownPaymentsToDrawReturns an instance of DownPaymentsToDraw object holding properties of available down payments (sales and purchase) that can be drawn to A/R or A/P invoice.
Public Property DownPaymentTrasactionIDproperty DownPaymentTrasactionID
Public Property DownPaymentTypeReturns or sets a value specifying whether the down payment document is invoice or request.

Field name: Posted.

Public Property DraftKeyDocument draft internal ID.

Field name: draftKey.

Public Property DutyStatusWhether this document is with or without payment of duty.

Field name: DutyStatus.

Public Property ECommerceGSTINproperty ECommerceGSTIN
Public Property ECommerceOperatorproperty ECommerceOperator
Public Property EDeliveryInfoInformation about electronic marketing documents for deliveries.
Public Property EDocErrorCodeproperty EDocErrorCode
Public Property EDocErrorMessageproperty EDocErrorMessage
Public Property EDocExportFormatproperty EDocExportFormat
Public Property EDocGenerationTypeproperty EDocGenerationType
Public Property EDocNumproperty EDocNum
Public Property EDocSeriesproperty EDocSeries
Public Property EDocStatusproperty EDocStatus
Public Property EDocTypeproperty EDocType
Public Property ElecCommMessageproperty ElecCommMessage
Public Property ElecCommStatusproperty ElecCommStatus
Public Property ElectronicProtocolsproperty ElectronicProtocols
Public Property EndAtproperty EndAt
Public Property EndDeliveryDateproperty EndDeliveryDate
Public Property EndDeliveryTimeproperty EndDeliveryTime
Public Property ETaxNumberproperty ETaxNumber
Public Property ETaxWebSiteproperty ETaxWebSite
Public Property EWayBillDetailsproperty EWayBillDetails
Public Property ExcludeFromTaxReportControlStatementVATproperty ExcludeFromTaxReportControlStatementVAT
Public Property ExemptionValidityDateFromSets or returns the Exemption Validity Date From. This property is linked to the ExemptionValidityDateFrom property of the BusinessPartners object. Relevant to invoice documents only.

Field name: FromDate.

Public Property ExemptionValidityDateToSets or returns the Exemption Validity Date To. This property is linked to the ExemptionValidityDateTo property of the BusinessPartners object. Relevant to invoice documents only.

Field name: ToDate.

Public Property ExpensesReturns the DocumentsAdditionalExpenses child object.
Public Property ExternalCorrectedDocNumNot used.

Field name: CorrExt.

Public Property ExtraDaysproperty ExtraDays
Public Property ExtraMonthproperty ExtraMonth
Public Property FatherCardSets or returns the card code of the parent business partner (for example, card code of the head office related to the current business partner).

Field name: FatherCard.

Length: 15 characters.

Public Property FatherTypeSets or returns a valid value of BoFatherCardTypes that specifies the method of handling deliveries and payments used by the parent business partner.

Field name: FatherType.

Public Property FCEAsPaymentMeansproperty FCEAsPaymentMeans
Public Property FCIEnter the FCI Number.

Field name: FCI.

Length: 36 characters.

Public Property FederalTaxIDSets or returns the federal tax ID of the business partner.

Field name: LicTradNum.

Length: 32 characters.

Public Property FinancialPeriodReturns the financial period.

Field name: FinncPriod.

This is a foreign key to the CompanyService object.

Public Property FiscalDocNumproperty FiscalDocNum
Public Property FolioNumberSets or returns the additional number for a printed document.

Field name: FolioNum.

Public Property FolioNumberFromproperty FolioNumberFrom
Public Property FolioNumberToproperty FolioNumberTo
Public Property FolioPrefixStringSets or returns the prefix for the FolioNumber.

Field name: FolioPref.

Length: 2 characters.

Public Property Form1099Sets or returns the 1099 form.

Field name: Form1099.

This is a foreign key to the Forms1099 object.

Sets or returns the code of the Form 1099.

Field name: FormCode.

This is a foreign key to the Forms1099 object.

Public Property GroupHandWrittenSpecify whether to have the manual number of the purchase quotation group.

Field name: PQTGrpHW.

Public Property GroupNumber

Number of the purchase quotation group. That is, all items that are contained in one purchase quotation share the same group number.

Field: PQTGrpNum.

Public Property GroupSeriesSets or returns the auto-number series that are generated for the purchase quotation group.

Field name: PQTGrpSer.

Public Property GSTTransactionTypeproperty GSTTransactionType
Public Property GTSCheckerproperty GTSChecker
Public Property GTSPayeeproperty GTSPayee
Public Property HandWrittenDetermines whether or not this document is based on a handwritten document.

Field name: Handwrtten.

Public Property ImportFileNumSets or returns the landed costs key (import file number). The import file is used as a basis for purchase documents (purchase order and goods receipt).

Field name: LndCstNum.

Public Property IndicatorSets or returns the factoring indicator .

Field name: Indicator.

This is a foreign key to the FactoringIndicators object.

The Factoring Indicators object enables to define a key that can be used as a selection criterion in various reports.

Sets or returns the Factoring Indicator for the business partner master record.

Field name: Indicator.

Length: 2 characters.

This is a foreign key to the FactoringIndicators object.

Public Property IndicatorForFinalConsumerThe checkbox Final Consumer on the header of an A/R invoice, A/R sales order, A/R sales quotation, delivery, return or credit note.

Field name: IndFinal.

Public Property InstallmentsReturns an instance of Document_Installments object holding installments properties.
Public Property InsuranceOperation347Indicates if this document is reported with the insurance operation type in 347 reports.

Field name: InsurOp347

Public Property InterimTypeproperty InterimType
Public Property InternalCorrectedDocNumNot used.
Public Property IntrastatExpensesproperty IntrastatExpenses
Public Property InventoryStatusproperty InventoryStatus
Public Property InvoicePaymentproperty InvoicePayment
Public Property IsAlterationproperty IsAlteration
Public Property IsPayToBankSets 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.

Public Property IssuingReasonproperty IssuingReason
Public Property JournalMemoSets or returns the journal entry remarks that is copied later to the accounting document.

Field name: JrnlMemo.

Length: 50 characters.

Public Property LanguageCodeSets or returns the Language Code of the document. Field name: LangCode.

Field name: LangCode.

This is the foreign key of the UserLanguages object.

Public Property LastPageFolioNumberFolio number of the last page of the marketing document in the Chile localization.

Field name: LPgFolioN.

Public Property LegalTextFormatLegal text format template.

Field name: LegTextF.

Public Property Letterproperty Letter
Public Property LinesReturns the Document_Lines child object.
Public Property ManualNumberSets or returns the manual number of the document.

Field name: ExpAnSys.

Length: 20 characters.

Public Property MaximumCashDiscountSets or returns a valid value of BoYesNoEnum type that specifies whether or not to calculate the discount in a payment run even if its due date is expired.

Field name: MaxDscn.

Public Property NetProcedureSets or returns a valid value of BoYesNoEnum type that specifies whether or not to calculate a cash discount in A/P invoices according the payment terms with the vendor.

Field name: NetProc.

Public Property NextCorrectingDocumentNot used.
Public Property NotRelevantForMonthlyInvoiceExcludes specific documents from the monthly invoice.

Field name: NotRel4MI.

Public Property NTSApprovedproperty NTSApproved
Public Property NTSApprovedNumberproperty NTSApprovedNumber
Public Property NumAtCardSets or returns a unique code by which your vendor/customer identifies your company.

Field name: NumAtCard.

Length: 100 characters.

Public Property NumberOfInstallmentsSets or returns the number of installments for the payment.

Field name: Installmnt.

Public Property OpenForLandedCostsEnables the landed costs feature.

Field name: OpenForLaC.

Public Property OpeningRemarksSets or returns the Header text of the sales or purchasing document.

Field name: Header.

Length: 64000 characters.

Public Property OriginalCreditOrDebitDateproperty OriginalCreditOrDebitDate
Public Property OriginalCreditOrDebitNoproperty OriginalCreditOrDebitNo
Public Property OriginalRefDateproperty OriginalRefDate
Public Property OriginalRefNoproperty OriginalRefNo
Public Property PackagesReturns the DocumentPackages object, which is a child object of Documents holding package details for items in Delivery and A/R Invoice documents.
Public Property PaidToDateproperty PaidToDate
Public Property PaidToDateFCproperty PaidToDateFC
Public Property PaidToDateSysproperty PaidToDateSys
Public Property PartialSupplySets or returns a valid value of BoYesNoEnum type that specifies whether or not only some of the items were supplied to the customer.

Field name: PartSupply.

Public Property PaymentBlockSets or returns a valid value of BoYesNoEnum type that specifies whether or not to block a payment due to a reason specified in PaymentBlockEntry property.

Field name: PayBlock.

Public Property PaymentBlockEntrySets or returns a description of the payment block reason as defined in SAP Business One in 'Define Payment Block' table.

Field name: PayBlckRef.

This is a foreign key to the OPYB object.

Public Property PaymentGroupCodeSets or returns the payment terms used in the document .

Field name: GroupNum.

This is a foreign key to the PaymentTermsTypes object.

Public Property PaymentMethodSets or returns the payment method for outgoing payments (for example: check, bank transfer, and so on).

Field name: PeyMethod.

Length: 15 characters.

This is a foreign key to the WizardPaymentMethods object.

Public Property PaymentReferenceReturns the payment reference that authorizes the payment process (according to the legal requirements).

Field name: PaymentRef.

Length: 27 characters.

Public Property PayToBankAccountNoSets or returns the bank account number for the outgoing payment.

Field name: BnkAccount.

Length: 50 characters.

Public Property PayToBankBranchSets or returns the bank branch for the outgoing payment.

Field name: BnkBranch.

Length: 50 characters.

Public Property PayToBankCodeSets or returns the bank code for the outgoing payment.

Field name: BankCode.

Length: 30 characters.

Public Property PayToBankCountrySets or returns the bank country for the outgoing payment.

Field name: BnkCntry.

Length: 3 characters.

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

Public Property PayToCodeSets or returns the destination code for the outgoing payment.

Field name: PayToCode.

Length: 50 characters.

Public Property PeriodIndicatorReturns the period indicator of the document.

Field name: PIndicator.

Length: 10 characters.

This is a foreign key to the Period Indicator table (OPID - not exposed through the DI API).

Public Property PickReturns a valid value of BoYesNoEnum type that specifies whether or not to create a pick list document.

Field name: pick.

Public Property PickRemarkSets or returns the Pick Remarks, the remarks related to the pick process .

Field name: PickRmrk.

Length: 254 characters.

Public Property PickStatusReturns a valid value that specifies the picking status of the items specified in the document: picked, not picked, released for picking, or partially picked from the warehouse.

Field name: PickStatus.

Public Property PlasticPackagingTaxRelevantDocument relevant for plastic packaging tax in UK localization.

Field name: Rel4PPTax.

Public Property PointOfIssueCodeproperty PointOfIssueCode
Public Property POS_CashRegisterproperty POS_CashRegister
Public Property POSCashierNumberproperty POSCashierNumber
Public Property POSDailySummaryNoproperty POSDailySummaryNo
Public Property POSEquipmentNumberproperty POSEquipmentNumber
Public Property POSManufacturerSerialNumberproperty POSManufacturerSerialNumber
Public Property POSReceiptNoproperty POSReceiptNo
Public Property PriceListNumproperty PriceListNum
Public Property PriceModeproperty PriceMode
Public Property PrintedSets or returns a valid value of PrintStatusEnum type that specifies whether or not this document was printed.

Field name: Printed.

Public Property PrintSEPADirectproperty PrintSEPADirect
Public Property PrivateKeyVersionproperty PrivateKeyVersion
Public Property ProjectSets or returns the project code related to the document.

Field name: Project.

Length: 8 characters

This is a foreign key to Project Codes table - OPRJ. You can work with this table using the ProjectsService.

Public Property Receiverproperty Receiver
Public Property Reference1Sets or returns the first reference code of the document.

Field name: Ref1.

Length: 11 characters.

Public Property Reference2Sets or returns the second reference code of the document.

Field name: Ref2.

Length: 11 characters.

This property is relevant also for oInventoryGenEntry and oInventoryGenExit document types.

Public Property RelatedEntryproperty RelatedEntry
Public Property RelatedTypeproperty RelatedType
Public Property Releaserproperty Releaser
Public Property RelevantToGTSproperty RelevantToGTS
Public Property ReopenManuallyClosedOrCanceledDocumentSpecifies whether to reopen an original document that was manually closed or cancelled.

Field: ReopManCls.

Public Property ReopenOriginalDocumentSpecifies whether to reopen a sales or purchasing order when you create a return or goods return document that is based on the sales or purchasing order, or when you create a credit memo based on an invoice.

Field: ReopOriDoc.

Public Property ReportingSectionControlStatementVATproperty ReportingSectionControlStatementVAT
Public Property ReqCodeRequester code.

Field name: ReqCode.

Length: 50 characters.

Public Property ReqTypeproperty ReqType
Public Property Requesterproperty Requester
Public Property RequesterBranchproperty RequesterBranch
Public Property RequesterDepartmentproperty RequesterDepartment
Public Property RequesterEmailproperty RequesterEmail
Public Property RequesterNameproperty RequesterName
Public Property RequriedDateSets or returns the date in which the customer expects the goods.

Field name: ReqDate.

Public Property ReserveReturns a valid value that specifies whether or not this document was saved by the payment wizard.

Field name: Reserve.

Public Property ReserveInvoiceDetermines whether or not this document is a Reserve Invoice, invoice that can be drawn to a delivery.

Field name: isIns.

Public Property ReuseDocumentNumproperty ReuseDocumentNum
Public Property ReuseNotaFiscalNumproperty ReuseNotaFiscalNum
Public Property Revisionproperty Revision
Public Property RevisionPoSets or returns a valid value of BoYesNoEnum type that specifies whether or not to split a purchase order to different warehouses in different locations.

Field name: RevisionPo.

Public Property RoundingSets or returns a valid value of BoYesNoEnum type that specifies whether or not to round the total amount in sales or purchase documents.

Field name: Rounding.

Public Property RoundingDiffAmountThe difference between the original amount and the rounded amount.

Field name: RoundDif

Public Property RoundingDiffAmountFCThe difference between the original amount and the rounded amount in foreign currency.

Field name: RoundDifFC

Public Property RoundingDiffAmountSCThe difference between the original amount and the rounded amount in system currency.

Field name: RoundDifSy

Public Property RoutingCodeThis is a code used in France’s e-invoicing system to route invoices to the correct recipient platform via the centralized Annuaire directory; it complements the mandatory SIREN number.

Field name: RoutingCod.

Public Property SalesPersonCodeSets or returns the code of the sales employee who has created this document.

Field name: SlpCode.

This is a foreign key to the SalesPersons object.

Public Property SAPPassportproperty SAPPassport
Public Property SegmentReturns the segment number of a child document related to a parent document (parent document number is the value of DocNum property).

Field name: Segment.

Public Property SendNotificationproperty SendNotification
Public Property SequenceCodeSets or returns the Sequence Code.

Field name: SeqCode.

Public Property SequenceModelSets or returns the Nota Fiscal Model.

Field name: Model.

Public Property SequenceSerialSets or returns the Nota Fiscal Sequence Serial .

Field name: Serial.

Public Property SeriesSets or returns the auto-number series that generated the document number.

Field name: Series.

This is a foreign key to the Series object.

Public Property SeriesStringSets or returns the Series String.

Field name: SeriesStr.

Length: 3 characters.

Public Property ServiceGrossProfitPercentThe gross profit percent for a service document.

Field name: SrvGpPrcnt

Public Property ShipFromproperty ShipFrom
Public Property ShipPlaceEnter Shipment Place Name. It is mandatory if Export Process form is filled in..

Field name: ShipPlace.

Length: 60 characters.

Public Property ShipStateEnter Shipment State Code. It is mandatory if Export Process form is filled in..

Field name: ShipState.

Length: 3 characters.

Public Property ShipToCodeSets or returns the Ship To address name.

Field name: ShipToCode.

Length: 50 characters.

Public Property ShipToCodeForReturnSets or returns the Ship To address in return documents.

Field name: RShipToCod.

Length: 50 characters.

Public Property ShowSCNSets or returns a valid value of BoYesNoEnum type that specifies whether or not to show the BP catalog number instead of item code.

Field name: ShowSCN.

Public Property SignatureDigestproperty SignatureDigest
Public Property SignatureInputMessageproperty SignatureInputMessage
Public Property SirenNumberThis is a French business identifier. SIREN (9 digits) identifies a company.

Field name: SirenNo.

Public Property SiretNumberThis is a French business identifier. SIRET (14 digits) identifies a specific establishment.

Field name: SiretNo.

Public Property SOIWizardIdproperty SOIWizardId
Public Property SpecialLinesReturns an instance of Document_SpecialLines object holding properties for text or subtotal lines in documents.
Public Property SpecifiedClosingDateTo close a goods receipt PO or a goods return, specify a date other than the current system date and the original posting date.

Field: SpecDate.

Public Property StartDeliveryDateproperty StartDeliveryDate
Public Property StartDeliveryTimeproperty StartDeliveryTime
Public Property StartFromproperty StartFrom
Public Property SubmittedReturns a valid value of BoYesNoEnum type that specifies whether or not the document was submitted.

Field name: submitted.

Public Property SubSeriesStringSets or returns the document's Subseries String.

Field name: SubStr.

Length: 3 characters.

Public Property SuffixThis field provides additional information or helps organize invoices, especially when multiple systems or departments are involved in the invoicing process. While not a mandatory part of all e-Invoicing standards, it is common practice for businesses to use it for internal management or specific transactional data.

Field name: Suffix.

Length: 3 characters.

Public Property SummeryTypeSets or returns a valid value of BoDocSummaryTypes type that specifies the summary method to be used for table rows in a document.

Field name: SummryType.

Public Property Supplierproperty Supplier
Public Property TaxDateSets or returns the date for the tax calculation or payment.

Field name: TaxDate.

Public Property TaxExemptionLetterNumSets or returns the tax exemption letter number.

Field name: LetterNum.

Length: 20 characters.

Public Property TaxExtensionSets or returns the Tracking Number.

Field name: TrackNo.

Length: 30 characters.

Public Property TaxInvoiceDateproperty TaxInvoiceDate
Public Property TaxInvoiceNoproperty TaxInvoiceNo
Public Property TaxOnInstallmentsIndicates the types to apply tax on installment.
Public Property TotalDiscountReturns the Total Discount for current document.

Field name: DiscSum.

Public Property TotalDiscountFCproperty TotalDiscountFC
Public Property TotalDiscountSCproperty TotalDiscountSC
Public Property TotalEqualizationTaxReturns the total equalization tax amount, in local currency, calculated for the document.

Field name: EquVatSum.

Public Property TotalEqualizationTaxFCReturns the total equalization tax amount, in foreign currency, calculated for the document.

Field name: EquVatSumF.

Public Property TotalEqualizationTaxSCReturns the total equalization tax amount, in system currency, calculated for the document.

Field name: EquVatSumS.

Public Property TrackingNumberproperty TrackingNumber
Public Property TransNumReturns the transaction number that SAP Business One creates for the document.

Field name: TransId.

This is a foreign key to the JournalEntries object.

Public Property TransportationCodeSets or returns the shipping type.

Field name: TrnspCode.

This is a foreign key to the ShippingTypes object.

Sets or returns the code of the shipping type (such as, Courier or Air Cargo).

Field name: ShipType.

This is a foreign key to the ShippingTypes object.

Public Property UpdateDateReturns the date when the document was last updated.

Field name: UpdateDate.

Public Property UpdateTimeproperty UpdateTime
Public Property UseBillToAddrToDetermineTaxproperty UseBillToAddrToDetermineTax
Public Property UseCorrectionVATGroupSets or returns a valid value that determines wether or not to use the correction vat group.

Field name: UseCorrVat.

Public Property UserFieldsReturns the UserFields object.
Public Property UserSignReturns the ID of the user who enters the object's details.

Field name: UserSign.

This is a foreign key to the Users object.

Public Property UseShpdGoodsActSets or returns a valid value of BoYesNoEnum type that specifies whether or not the document uses Shipped Goods account.

Field name: UseShpdGd.

Public Property VatDateSets or returns the date from which the tax rate for this VAT Group code applies.

Field name: vatdate.

Public Property VatPercentThe tax rate for the document.

Field name: VatPercent

Public Property VATRegNumproperty VATRegNum
Public Property VatSumReturns the total tax amount, in local currency, calculated for the document.

Field name: VatSum.

Public Property VatSumFcReturns the total tax amount, in foreign currency, calculated for the document.

Field name: VatSumFC.

Public Property VatSumSysReturns the total tax amount, in system currency, calculated for the document.

Field name: VatSumSy.

Public Property VehiclePlateproperty VehiclePlate
Public Property WareHouseUpdateTypeNot Used.

Field name: InvntSttus.

Public Property WithholdingTaxDataReturns the WithholdingTaxData object.
Public Property WithholdingTaxDataWTXproperty WithholdingTaxDataWTX
Public Property WTAmountReturns the total withholding tax amount in the document, in local currency.

Field name: WTSum.

Public Property WTAmountFCReturns the total withholding tax amount in the document, in local currency.

Field name: WTSumSC.

Public Property WTAmountSCReturns the total withholding tax amount in the document, in system currency.

Field name: WTSumSC.

Public Property WTAppliedReturns the total withholding tax applied, in local currency.

Field name: WTApplied.

Public Property WTAppliedFCReturns the total withholding tax applied, in foreign currency.

Field name: WTAppliedF.

Returns the total withholding tax amount in the document, in local currency.

Field name: WTSumSC.

Public Property WTAppliedSCReturns the total withholding tax applied, in system currency.

Field name: WTAppliedS.

Public Property WTExemptedAmountReturns the exempted amount, in local currency, from the document.

Field name: ExepAmnt.

Public Property WTExemptedAmountFCReturns the exempted amount, in foreign currency, from the document.

Field name: ExepAmntFC.

Public Property WTExemptedAmountSCReturns the exempted amount, in system currency, from the document.

Field name: ExepAmntSC.

Public Property WTNonSubjectAmountReturns the amount, in local currency, that is not subject to withholding tax in the document.

Field name: NnSbAmnt.

Public Property WTNonSubjectAmountFCReturns the amount, in foreign currency, that is not subject to withholding tax in the document.

Field name: NbSbAmntFC.

Public Property WTNonSubjectAmountSCReturns the amount, in system currency, that is not subject to withholding tax in the document.

Field name: NnSbAmntSC.

See Also