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

• Documents Object Members

  • Tablelist
  • DI API
  • Service Layer

  • • Public Methods

      Add	Adds a record to the object table in SAP Business One company database.
      Cancel	Cancels a record from the object table.
      Close	Closes a record of the object in SAP Business One database.
      CreateCancellationDocument	Creates a cancellation document when a marketing document is added in error, has become invalid, or has no concrete transactions associated with it.
      ExportEWayBill	method ExportEWayBill
      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. If serial numbers and batch numbers are set to the specified Document object lines, the returned object will contain references to these child objects.
      HandleApprovalRequest	method HandleApprovalRequest
      Remove	Not supported. SAP Business One does not allow to remove a document object from the database.   Note: The remove feature is supported for Purchase Quotation.
      Reopen	Reopens a closed document. The method is only relevant for China, Japan, Korea, India, Brazil and Singapore.
      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.
      UpdateFromXML	Receives and processes the XML content. You can remove sub-object lines from the Document object via the XML file.

  • • Public Properties

      AdditionalLegalInformation	Additional legal information text. Field name: AddLegIn. Length: 100 characters.
      Address	The 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
      Address2	The 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
      AddressExtension	The 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: Clears the Address and Address2 properties. 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. Copies these addresses to the Address and Address2 properties.
      AddressForReturn	Sub-object of address for return documents. Field name: Address3 Length: 254 characters
      AgentCode	Sets 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.
      AllocationNumberIL	Allocation Number (used in Electronic Invoice for Israel)
      AnnualInvoiceDeclarationReference	property AnnualInvoiceDeclarationReference
      ApplyCurrentVATRatesForDownPaymentsToDraw	property ApplyCurrentVATRatesForDownPaymentsToDraw
      ApplyTaxOnFirstInstallment	Sets 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.
      ArchiveNonremovableSalesQuotation	Indicates 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
      AssetValueDate	property AssetValueDate
      ATDocumentType	property ATDocumentType
      AttachmentEntry	The attachment for marketing documents. Field name: AtcEntry
      AuthorizationCode	property AuthorizationCode
      AuthorizationStatus	Returns the status of the authorization for this payment. Field name: wddStatus.
      BaseAmount	Returns the net amount (amount excluding tax, including expenses) of the document, in local currency. Field name: BaseAmnt.
      BaseAmountFC	Returns the net amount (amount excluding tax, including expenses) of the document, in foreign currency. Field name: BaseAmntFC.
      BaseAmountSC	Returns the net amount (amount excluding tax, including expenses) of the document, in system currency. Field name: BaseAmntSC.
      BaseEntry	The base document internal key for inventory transfer in India localization. Field name: BaseEntry.
      BaseType	The base document type for inventory transfer in India localization. The object code for WTR is 67. Field name: BaseType.
      BillOfExchangeReserved	Not used. Field name: BoeReserev.
      BlanketAgreementNumber	property BlanketAgreementNumber
      BlockDunning	Sets 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.
      Box1099	Default 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.
      BPChannelCode	Sets 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.
      BPChannelContact	Sets or returns the contact person of the business partner channel. Field name: BPChCntc. This is a foreign key to the ContactEmployees object.
      BPL_IDAssignedToInvoice	Sets or returns the business place ID assigned to a marketing document (such as, invoice). Field name: BPLId.
      BPLName	property BPLName
      Browser	Returns the DataBrowser object.
      CancelDate	Sets 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.
      Cancelled	Indicates whether the document was cancelled.
      CancelStatus	Indicates the document cancel status.
      CardCode	Sets 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
      CardName	Sets 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.
      CashDiscountDateOffset	property CashDiscountDateOffset
      CentralBankIndicator	Sets 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)
      CertificationNumber	property CertificationNumber
      Cig	property Cig
      ClosingDate	Set or retrieves Document closing date. Field name: ClsDate.
      ClosingOption	To close a goods receipt PO or a goods return, specify a posting date to be used in the clearing journal entry. Field: ClosingOpt.
      ClosingRemarks	Sets or returns the Footer text of the sales or purchasing document. Field name: Footer. Length: 64000 characters.
      Comments	Sets or returns comments for the document. Field name: Comments. Length: 254 characters.
      CommissionTrade	property CommissionTrade
      CommissionTradeReturn	property CommissionTradeReturn
      Confirmed	Sets 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.
      ContactPersonCode	Sets or returns the Contact Person code. Field name: CntctCode. This is a foreign key to the ContactEmployees object.
      ControlAccount	The control account for this document. Field name: CtlAccount This is a foreign key to the ChartOfAccounts object.
      CreateOnlineQuotation	property CreateOnlineQuotation
      CreateQRCodeFrom	property CreateQRCodeFrom
      CreationDate	Returns the creation date of the document. Field name: CreateDate.
      Cup	property Cup
      CustOffice	Enter Customs Office Name. It is mandatory if Export Process form is filled in.. Field name: CustOffice. Length: 60 characters.
      DANFELegalText	DANFE Legal Text. Field name: DANFELgTxt.
      DateOfReportingControlStatementVAT	property DateOfReportingControlStatementVAT
      DeferredTax	Sets 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.
      DigitalPayments	Indicates whether it uses digital payment. Field name: DigPayment.
      DigitalPayToAddress	The pay-to address of the digital payment. Field name: DPayToAddr. Length: 50 characters.
      DiscountPercent	Sets or returns the discount percentage you specify for a customer, or the discount percentage a supplier specifies for you. Field name: Discount.
      DocCurrency	Sets or returns the currency used in the document. Field name: DocCur. Length: 3 characters. This is a foreign key to the Currencies object.
      DocDate	Sets or returns the document posting date. Field name: DocDate.
      DocDueDate	Sets 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.
      DocEntry	Returns the document entry key that uniquely identifies the document. Field name: DocEntry.
      DocNum	Sets 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.
      DocObjectCode	Sets 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.
      DocObjectCodeEx	Sets or returns the a valid value of BoObjectTypes that defines the document object code (replaces the valid values of DocObjectCode property).
      DocRate	Sets or returns the exchange rate with local currency for the document. Field name: DocRate.
      DocTime	Sets or returns the document creation time. Field name: DocTime.
      DocTotal	Sets or returns the total amount in the document. Field name: DocTotal.
      DocTotalFc	Sets or returns the total amount, in foreign currency, in the document. Field name: DocTotalFC.
      DocTotalSys	Sets or returns the total amount, in system currency, in the document. Field name: DocTotalSy.
      DocType	Sets or returns a valid value of BoDocumentTypes type that specifies the business transaction content type: Items Transaction or Service Transaction. Field name: DocType.
      Document_ApprovalRequests	Returns the Document_ApprovalRequests object.
      DocumentDelivery	Property DocumentDelivery
      DocumentReferences	property DocumentReferences
      DocumentsOwner	Sets or returns the document owner. Field name: OwnerCode. This is a foreign key to the EmployeesInfo object.
      DocumentStatus	Returns a valid value of BoStatus type that specifies document status (closed or open). Field name: DocStatus.
      DocumentSubType	Sets or returns a valid value of BoDocumentSubType type that specifies document sub-type. Field name: DocSubType.
      DocumentTaxID	property DocumentTaxID
      DownPayment	Deprecated in Release 2006 A. Instead, use the properties DownPaymentAmount, DownPaymentAmountFC, DownPaymentAmountSC.
      DownPaymentAmount	Returns the total down payment amount in local currency. Field name: DpmAmnt.
      DownPaymentAmountFC	Returns the total down payment amount in foreign currency. Field name: DpmAmntFC.
      DownPaymentAmountSC	Returns the total down payment amount in system currency. Field name: DpmAmntSC.
      DownPaymentPercentage	Sets or returns percentage of down payment. Field name: DpmPrcnt.
      DownPaymentStatus	property DownPaymentStatus
      DownPaymentsToDraw	Returns 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.
      DownPaymentTrasactionID	property DownPaymentTrasactionID
      DownPaymentType	Returns or sets a value specifying whether the down payment document is invoice or request. Field name: Posted.
      DraftKey	Document draft internal ID. Field name: draftKey.
      DutyStatus	Whether this document is with or without payment of duty. Field name: DutyStatus.
      ECommerceGSTIN	property ECommerceGSTIN
      ECommerceOperator	property ECommerceOperator
      EDeliveryInfo	Information about electronic marketing documents for deliveries.
      EDocErrorCode	property EDocErrorCode
      EDocErrorMessage	property EDocErrorMessage
      EDocExportFormat	property EDocExportFormat
      EDocGenerationType	property EDocGenerationType
      EDocNum	property EDocNum
      EDocSeries	property EDocSeries
      EDocStatus	property EDocStatus
      EDocType	property EDocType
      ElecCommMessage	property ElecCommMessage
      ElecCommStatus	property ElecCommStatus
      ElectronicProtocols	property ElectronicProtocols
      EndAt	property EndAt
      EndDeliveryDate	property EndDeliveryDate
      EndDeliveryTime	property EndDeliveryTime
      ETaxNumber	property ETaxNumber
      ETaxWebSite	property ETaxWebSite
      EWayBillDetails	property EWayBillDetails
      ExcludeFromTaxReportControlStatementVAT	property ExcludeFromTaxReportControlStatementVAT
      ExemptionValidityDateFrom	Sets 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.
      ExemptionValidityDateTo	Sets 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.
      Expenses	Returns the DocumentsAdditionalExpenses child object.
      ExternalCorrectedDocNum	Not used. Field name: CorrExt.
      ExtraDays	property ExtraDays
      ExtraMonth	property ExtraMonth
      FatherCard	Sets 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.
      FatherType	Sets 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.
      FCEAsPaymentMeans	property FCEAsPaymentMeans
      FCI	Enter the FCI Number. Field name: FCI. Length: 36 characters.
      FederalTaxID	Sets or returns the federal tax ID of the business partner. Field name: LicTradNum. Length: 32 characters.
      FinancialPeriod	Returns the financial period. Field name: FinncPriod. This is a foreign key to the CompanyService object.
      FiscalDocNum	property FiscalDocNum
      FolioNumber	Sets or returns the additional number for a printed document. Field name: FolioNum.
      FolioNumberFrom	property FolioNumberFrom
      FolioNumberTo	property FolioNumberTo
      FolioPrefixString	Sets or returns the prefix for the FolioNumber. Field name: FolioPref. Length: 2 characters.
      Form1099	Sets 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.
      GroupHandWritten	Specify whether to have the manual number of the purchase quotation group. Field name: PQTGrpHW.
      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.
      GroupSeries	Sets or returns the auto-number series that are generated for the purchase quotation group. Field name: PQTGrpSer.
      GSTTransactionType	property GSTTransactionType
      GTSChecker	property GTSChecker
      GTSPayee	property GTSPayee
      HandWritten	Determines whether or not this document is based on a handwritten document. Field name: Handwrtten.
      ImportFileNum	Sets 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.
      Indicator	Sets 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.
      IndicatorForFinalConsumer	The 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.
      Installments	Returns an instance of Document_Installments object holding installments properties.
      InsuranceOperation347	Indicates if this document is reported with the insurance operation type in 347 reports. Field name: InsurOp347
      InterimType	property InterimType
      InternalCorrectedDocNum	Not used.
      IntrastatExpenses	property IntrastatExpenses
      InventoryStatus	property InventoryStatus
      InvoicePayment	property InvoicePayment
      IsAlteration	property IsAlteration
      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.
      IssuingReason	property IssuingReason
      JournalMemo	Sets or returns the journal entry remarks that is copied later to the accounting document. Field name: JrnlMemo. Length: 50 characters.
      LanguageCode	Sets or returns the Language Code of the document. Field name: LangCode. Field name: LangCode. This is the foreign key of the UserLanguages object.
      LastPageFolioNumber	Folio number of the last page of the marketing document in the Chile localization. Field name: LPgFolioN.
      LegalTextFormat	Legal text format template. Field name: LegTextF.
      Letter	property Letter
      Lines	Returns the Document_Lines child object.
      ManualNumber	Sets or returns the manual number of the document. Field name: ExpAnSys. Length: 20 characters.
      MaximumCashDiscount	Sets 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.
      NetProcedure	Sets 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.
      NextCorrectingDocument	Not used.
      NotRelevantForMonthlyInvoice	Excludes specific documents from the monthly invoice. Field name: NotRel4MI.
      NTSApproved	property NTSApproved
      NTSApprovedNumber	property NTSApprovedNumber
      NumAtCard	Sets or returns a unique code by which your vendor/customer identifies your company. Field name: NumAtCard. Length: 100 characters.
      NumberOfInstallments	Sets or returns the number of installments for the payment. Field name: Installmnt.
      OpenForLandedCosts	Enables the landed costs feature. Field name: OpenForLaC.
      OpeningRemarks	Sets or returns the Header text of the sales or purchasing document. Field name: Header. Length: 64000 characters.
      OriginalCreditOrDebitDate	property OriginalCreditOrDebitDate
      OriginalCreditOrDebitNo	property OriginalCreditOrDebitNo
      OriginalRefDate	property OriginalRefDate
      OriginalRefNo	property OriginalRefNo
      Packages	Returns the DocumentPackages object, which is a child object of Documents holding package details for items in Delivery and A/R Invoice documents.
      PaidToDate	property PaidToDate
      PaidToDateFC	property PaidToDateFC
      PaidToDateSys	property PaidToDateSys
      PartialSupply	Sets 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.
      PaymentBlock	Sets 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.
      PaymentBlockEntry	Sets 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.
      PaymentGroupCode	Sets or returns the payment terms used in the document . Field name: GroupNum. This is a foreign key to the PaymentTermsTypes object.
      PaymentMethod	Sets 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.
      PaymentReference	Returns the payment reference that authorizes the payment process (according to the legal requirements). Field name: PaymentRef. Length: 27 characters.
      PayToBankAccountNo	Sets or returns the bank account number for the outgoing payment. Field name: BnkAccount. Length: 50 characters.
      PayToBankBranch	Sets or returns the bank branch for the outgoing payment. Field name: BnkBranch. Length: 50 characters.
      PayToBankCode	Sets or returns the bank code for the outgoing payment. Field name: BankCode. Length: 30 characters.
      PayToBankCountry	Sets 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).
      PayToCode	Sets or returns the destination code for the outgoing payment. Field name: PayToCode. Length: 50 characters.
      PeriodIndicator	Returns 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).
      Pick	Returns a valid value of BoYesNoEnum type that specifies whether or not to create a pick list document. Field name: pick.
      PickRemark	Sets or returns the Pick Remarks, the remarks related to the pick process . Field name: PickRmrk. Length: 254 characters.
      PickStatus	Returns 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.
      PlasticPackagingTaxRelevant	Document relevant for plastic packaging tax in UK localization. Field name: Rel4PPTax.
      PointOfIssueCode	property PointOfIssueCode
      POS_CashRegister	property POS_CashRegister
      POSCashierNumber	property POSCashierNumber
      POSDailySummaryNo	property POSDailySummaryNo
      POSEquipmentNumber	property POSEquipmentNumber
      POSManufacturerSerialNumber	property POSManufacturerSerialNumber
      POSReceiptNo	property POSReceiptNo
      PriceListNum	property PriceListNum
      PriceMode	property PriceMode
      Printed	Sets or returns a valid value of PrintStatusEnum type that specifies whether or not this document was printed. Field name: Printed.
      PrintSEPADirect	property PrintSEPADirect
      PrivateKeyVersion	property PrivateKeyVersion
      Project	Sets 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.
      Receiver	property Receiver
      Reference1	Sets or returns the first reference code of the document. Field name: Ref1. Length: 11 characters.
      Reference2	Sets 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.
      RelatedEntry	property RelatedEntry
      RelatedType	property RelatedType
      Releaser	property Releaser
      RelevantToGTS	property RelevantToGTS
      ReopenManuallyClosedOrCanceledDocument	Specifies whether to reopen an original document that was manually closed or cancelled. Field: ReopManCls.
      ReopenOriginalDocument	Specifies 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.
      ReportingSectionControlStatementVAT	property ReportingSectionControlStatementVAT
      ReqCode	Requester code. Field name: ReqCode. Length: 50 characters.
      ReqType	property ReqType
      Requester	property Requester
      RequesterBranch	property RequesterBranch
      RequesterDepartment	property RequesterDepartment
      RequesterEmail	property RequesterEmail
      RequesterName	property RequesterName
      RequriedDate	Sets or returns the date in which the customer expects the goods. Field name: ReqDate.
      Reserve	Returns a valid value that specifies whether or not this document was saved by the payment wizard. Field name: Reserve.
      ReserveInvoice	Determines whether or not this document is a Reserve Invoice, invoice that can be drawn to a delivery. Field name: isIns.
      ReuseDocumentNum	property ReuseDocumentNum
      ReuseNotaFiscalNum	property ReuseNotaFiscalNum
      Revision	property Revision
      RevisionPo	Sets 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.
      Rounding	Sets 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.
      RoundingDiffAmount	The difference between the original amount and the rounded amount. Field name: RoundDif
      RoundingDiffAmountFC	The difference between the original amount and the rounded amount in foreign currency. Field name: RoundDifFC
      RoundingDiffAmountSC	The difference between the original amount and the rounded amount in system currency. Field name: RoundDifSy
      RoutingCode	This 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.
      SalesPersonCode	Sets 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.
      SAPPassport	property SAPPassport
      Segment	Returns the segment number of a child document related to a parent document (parent document number is the value of DocNum property). Field name: Segment.
      SendNotification	property SendNotification
      SequenceCode	Sets or returns the Sequence Code. Field name: SeqCode.
      SequenceModel	Sets or returns the Nota Fiscal Model. Field name: Model.
      SequenceSerial	Sets or returns the Nota Fiscal Sequence Serial . Field name: Serial.
      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.
      SeriesString	Sets or returns the Series String. Field name: SeriesStr. Length: 3 characters.
      ServiceGrossProfitPercent	The gross profit percent for a service document. Field name: SrvGpPrcnt
      ShipFrom	property ShipFrom
      ShipPlace	Enter Shipment Place Name. It is mandatory if Export Process form is filled in.. Field name: ShipPlace. Length: 60 characters.
      ShipState	Enter Shipment State Code. It is mandatory if Export Process form is filled in.. Field name: ShipState. Length: 3 characters.
      ShipToCode	Sets or returns the Ship To address name. Field name: ShipToCode. Length: 50 characters.
      ShipToCodeForReturn	Sets or returns the Ship To address in return documents. Field name: RShipToCod. Length: 50 characters.
      ShowSCN	Sets 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.
      SignatureDigest	property SignatureDigest
      SignatureInputMessage	property SignatureInputMessage
      SirenNumber	This is a French business identifier. SIREN (9 digits) identifies a company. Field name: SirenNo.
      SiretNumber	This is a French business identifier. SIRET (14 digits) identifies a specific establishment. Field name: SiretNo.
      SOIWizardId	property SOIWizardId
      SpecialLines	Returns an instance of Document_SpecialLines object holding properties for text or subtotal lines in documents.
      SpecifiedClosingDate	To 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.
      StartDeliveryDate	property StartDeliveryDate
      StartDeliveryTime	property StartDeliveryTime
      StartFrom	property StartFrom
      Submitted	Returns a valid value of BoYesNoEnum type that specifies whether or not the document was submitted. Field name: submitted.
      SubSeriesString	Sets or returns the document's Subseries String. Field name: SubStr. Length: 3 characters.
      Suffix	This 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.
      SummeryType	Sets 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.
      Supplier	property Supplier
      TaxDate	Sets or returns the date for the tax calculation or payment. Field name: TaxDate.
      TaxExemptionLetterNum	Sets or returns the tax exemption letter number. Field name: LetterNum. Length: 20 characters.
      TaxExtension	Sets or returns the Tracking Number. Field name: TrackNo. Length: 30 characters.
      TaxInvoiceDate	property TaxInvoiceDate
      TaxInvoiceNo	property TaxInvoiceNo
      TaxOnInstallments	Indicates the types to apply tax on installment.
      TotalDiscount	Returns the Total Discount for current document. Field name: DiscSum.
      TotalDiscountFC	property TotalDiscountFC
      TotalDiscountSC	property TotalDiscountSC
      TotalEqualizationTax	Returns the total equalization tax amount, in local currency, calculated for the document. Field name: EquVatSum.
      TotalEqualizationTaxFC	Returns the total equalization tax amount, in foreign currency, calculated for the document. Field name: EquVatSumF.
      TotalEqualizationTaxSC	Returns the total equalization tax amount, in system currency, calculated for the document. Field name: EquVatSumS.
      TrackingNumber	property TrackingNumber
      TransNum	Returns the transaction number that SAP Business One creates for the document. Field name: TransId. This is a foreign key to the JournalEntries object.
      TransportationCode	Sets 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.
      UpdateDate	Returns the date when the document was last updated. Field name: UpdateDate.
      UpdateTime	property UpdateTime
      UseBillToAddrToDetermineTax	property UseBillToAddrToDetermineTax
      UseCorrectionVATGroup	Sets or returns a valid value that determines wether or not to use the correction vat group. Field name: UseCorrVat.
      UserFields	Returns the UserFields object.
      UserSign	Returns the ID of the user who enters the object's details. Field name: UserSign. This is a foreign key to the Users object.
      UseShpdGoodsAct	Sets or returns a valid value of BoYesNoEnum type that specifies whether or not the document uses Shipped Goods account. Field name: UseShpdGd.
      VatDate	Sets or returns the date from which the tax rate for this VAT Group code applies. Field name: vatdate.
      VatPercent	The tax rate for the document. Field name: VatPercent
      VATRegNum	property VATRegNum
      VatSum	Returns the total tax amount, in local currency, calculated for the document. Field name: VatSum.
      VatSumFc	Returns the total tax amount, in foreign currency, calculated for the document. Field name: VatSumFC.
      VatSumSys	Returns the total tax amount, in system currency, calculated for the document. Field name: VatSumSy.
      VehiclePlate	property VehiclePlate
      WareHouseUpdateType	Not Used. Field name: InvntSttus.
      WithholdingTaxData	Returns the WithholdingTaxData object.
      WithholdingTaxDataWTX	property WithholdingTaxDataWTX
      WTAmount	Returns the total withholding tax amount in the document, in local currency. Field name: WTSum.
      WTAmountFC	Returns the total withholding tax amount in the document, in local currency. Field name: WTSumSC.
      WTAmountSC	Returns the total withholding tax amount in the document, in system currency. Field name: WTSumSC.
      WTApplied	Returns the total withholding tax applied, in local currency. Field name: WTApplied.
      WTAppliedFC	Returns 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.
      WTAppliedSC	Returns the total withholding tax applied, in system currency. Field name: WTAppliedS.
      WTExemptedAmount	Returns the exempted amount, in local currency, from the document. Field name: ExepAmnt.
      WTExemptedAmountFC	Returns the exempted amount, in foreign currency, from the document. Field name: ExepAmntFC.
      WTExemptedAmountSC	Returns the exempted amount, in system currency, from the document. Field name: ExepAmntSC.
      WTNonSubjectAmount	Returns the amount, in local currency, that is not subject to withholding tax in the document. Field name: NnSbAmnt.
      WTNonSubjectAmountFC	Returns the amount, in foreign currency, that is not subject to withholding tax in the document. Field name: NbSbAmntFC.
      WTNonSubjectAmountSC	Returns the amount, in system currency, that is not subject to withholding tax in the document. Field name: NnSbAmntSC.

  • • See Also

      Documents Overview