The IFreightInvoice type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddAdditionalDocumentRef |
Add a new 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Additional Document.
|
| AddAllowanceCharge |
Add a new 'Allowance Charge' entry.
Allowance Charge (ASBIE). An association to Allowances and Charges that apply to the Invoice as a whole.
|
| AddBillingReference |
Add a new 'Billing Reference' entry.
Billing Reference (ASBIE). An association to Billing Reference.
|
| AddContractDocumentRef |
Add a new 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Contract.
|
| AddDespatchDocumentRef |
Add a new 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Despatch Advice.
|
| AddInvoiceLine |
Add a new 'Invoice Line' entry.
Invoice Line (ASBIE). An association to one or more Invoice Lines.
|
| AddInvoicePeriod |
Add a new 'Period' entry.
Period (ASBIE). An association to period(s) to which the Invoice applies.
|
| AddNote |
Add a new 'Note' entry.
Note (BBIE). Free-form text applying to the Invoice. This element may contain notes or any other similar information that is not contained explicitly in another structure.
|
| AddOriginatorDocumentRef |
Add a new 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Originator Document.
|
| AddPaymentMeans |
Add a new 'Payment Means' entry.
Payment Means (ASBIE). An association to Payment Means.
|
| AddPaymentTerms |
Add a new 'Payment Terms' entry.
Payment Terms (ASBIE). An association to Payment Terms.
|
| AddPrepaidPayment |
Add a new 'Payment' entry.
Payment (ASBIE). An association to prepaid payment(s).
|
| AddReceiptDocumentRef |
Add a new 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Receipt Advice.
|
| AddSignature |
Add a new 'Signature' entry.
Signature (ASBIE). An association to Signature.
|
| AddTaxTotal |
Add a new 'Tax Total' entry.
Tax Total (ASBIE). An association to tax total for specific tax types/rates.
|
| AssignStyleSheet |
Assigns a XSLT stylesheet to the document.
|
| ClearAdditionalDocumentRefs |
Removes all 'Document Reference' entries.
Document Reference (ASBIE). An associative reference to Additional Document.
|
| ClearAllowanceCharges |
Removes all 'Allowance Charge' entries.
Allowance Charge (ASBIE). An association to Allowances and Charges that apply to the Invoice as a whole.
|
| ClearBillingReferences |
Removes all 'Billing Reference' entries.
Billing Reference (ASBIE). An association to Billing Reference.
|
| ClearContractDocumentRefs |
Removes all 'Document Reference' entries.
Document Reference (ASBIE). An associative reference to Contract.
|
| ClearDespatchDocumentRefs |
Removes all 'Document Reference' entries.
Document Reference (ASBIE). An associative reference to Despatch Advice.
|
| ClearInvoiceLines |
Removes all 'Invoice Line' entries.
Invoice Line (ASBIE). An association to one or more Invoice Lines.
|
| ClearInvoicePeriods |
Removes all 'Period' entries.
Period (ASBIE). An association to period(s) to which the Invoice applies.
|
| ClearNotes |
Removes all 'Note' entries.
Note (BBIE). Free-form text applying to the Invoice. This element may contain notes or any other similar information that is not contained explicitly in another structure.
|
| ClearOriginatorDocumentRefs |
Removes all 'Document Reference' entries.
Document Reference (ASBIE). An associative reference to Originator Document.
|
| ClearPaymentMeanss |
Removes all 'Payment Means' entries.
Payment Means (ASBIE). An association to Payment Means.
|
| ClearPaymentTermss |
Removes all 'Payment Terms' entries.
Payment Terms (ASBIE). An association to Payment Terms.
|
| ClearPrepaidPayments |
Removes all 'Payment' entries.
Payment (ASBIE). An association to prepaid payment(s).
|
| ClearReceiptDocumentRefs |
Removes all 'Document Reference' entries.
Document Reference (ASBIE). An associative reference to Receipt Advice.
|
| ClearSignatures |
Removes all 'Signature' entries.
Signature (ASBIE). An association to Signature.
|
| ClearTaxTotals |
Removes all 'Tax Total' entries.
Tax Total (ASBIE). An association to tax total for specific tax types/rates.
|
| GetAdditionalDocumentRef |
Gets a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Additional Document.
|
| GetAdditionalDocumentRefCount |
Gets the number of 'Document Reference' entries in the container object.
Document Reference (ASBIE). An associative reference to Additional Document.
|
| GetAllowanceCharge |
Gets a 'Allowance Charge' entry.
Allowance Charge (ASBIE). An association to Allowances and Charges that apply to the Invoice as a whole.
|
| GetAllowanceChargeCount |
Gets the number of 'Allowance Charge' entries in the container object.
Allowance Charge (ASBIE). An association to Allowances and Charges that apply to the Invoice as a whole.
|
| GetBillingReference |
Gets a 'Billing Reference' entry.
Billing Reference (ASBIE). An association to Billing Reference.
|
| GetBillingReferenceCount |
Gets the number of 'Billing Reference' entries in the container object.
Billing Reference (ASBIE). An association to Billing Reference.
|
| GetContractDocumentRef |
Gets a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Contract.
|
| GetContractDocumentRefCount |
Gets the number of 'Document Reference' entries in the container object.
Document Reference (ASBIE). An associative reference to Contract.
|
| GetDespatchDocumentRef |
Gets a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Despatch Advice.
|
| GetDespatchDocumentRefCount |
Gets the number of 'Document Reference' entries in the container object.
Document Reference (ASBIE). An associative reference to Despatch Advice.
|
| GetDocumentAsBinary |
Gets the document as binary data (UTF-8 encoded).
|
| GetDocumentAsText |
Gets the document as a string (UTF-8 encoded).
|
| GetInvoiceLine |
Gets a 'Invoice Line' entry.
Invoice Line (ASBIE). An association to one or more Invoice Lines.
|
| GetInvoiceLineCount |
Gets the number of 'Invoice Line' entries in the container object.
Invoice Line (ASBIE). An association to one or more Invoice Lines.
|
| GetInvoicePeriod |
Gets a 'Period' entry.
Period (ASBIE). An association to period(s) to which the Invoice applies.
|
| GetInvoicePeriodCount |
Gets the number of 'Period' entries in the container object.
Period (ASBIE). An association to period(s) to which the Invoice applies.
|
| GetNote |
Gets a 'Note' entry.
Note (BBIE). Free-form text applying to the Invoice. This element may contain notes or any other similar information that is not contained explicitly in another structure.
|
| GetNoteCount |
Gets the number of 'Note' entries in the container object.
Note (BBIE). Free-form text applying to the Invoice. This element may contain notes or any other similar information that is not contained explicitly in another structure.
|
| GetOriginatorDocumentRef |
Gets a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Originator Document.
|
| GetOriginatorDocumentRefCount |
Gets the number of 'Document Reference' entries in the container object.
Document Reference (ASBIE). An associative reference to Originator Document.
|
| GetPaymentMeans |
Gets a 'Payment Means' entry.
Payment Means (ASBIE). An association to Payment Means.
|
| GetPaymentMeansCount |
Gets the number of 'Payment Means' entries in the container object.
Payment Means (ASBIE). An association to Payment Means.
|
| GetPaymentTerms |
Gets a 'Payment Terms' entry.
Payment Terms (ASBIE). An association to Payment Terms.
|
| GetPaymentTermsCount |
Gets the number of 'Payment Terms' entries in the container object.
Payment Terms (ASBIE). An association to Payment Terms.
|
| GetPrepaidPayment |
Gets a 'Payment' entry.
Payment (ASBIE). An association to prepaid payment(s).
|
| GetPrepaidPaymentCount |
Gets the number of 'Payment' entries in the container object.
Payment (ASBIE). An association to prepaid payment(s).
|
| GetReceiptDocumentRef |
Gets a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Receipt Advice.
|
| GetReceiptDocumentRefCount |
Gets the number of 'Document Reference' entries in the container object.
Document Reference (ASBIE). An associative reference to Receipt Advice.
|
| GetSignature |
Gets a 'Signature' entry.
Signature (ASBIE). An association to Signature.
|
| GetSignatureCount |
Gets the number of 'Signature' entries in the container object.
Signature (ASBIE). An association to Signature.
|
| GetTaxTotal |
Gets a 'Tax Total' entry.
Tax Total (ASBIE). An association to tax total for specific tax types/rates.
|
| GetTaxTotalCount |
Gets the number of 'Tax Total' entries in the container object.
Tax Total (ASBIE). An association to tax total for specific tax types/rates.
|
| Read |
Reads the document from file.
|
| RemoveAdditionalDocumentRef |
Removes a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Additional Document.
|
| RemoveAllowanceCharge |
Removes a 'Allowance Charge' entry.
Allowance Charge (ASBIE). An association to Allowances and Charges that apply to the Invoice as a whole.
|
| RemoveBillingReference |
Removes a 'Billing Reference' entry.
Billing Reference (ASBIE). An association to Billing Reference.
|
| RemoveContractDocumentRef |
Removes a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Contract.
|
| RemoveDespatchDocumentRef |
Removes a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Despatch Advice.
|
| RemoveInvoiceLine |
Removes a 'Invoice Line' entry.
Invoice Line (ASBIE). An association to one or more Invoice Lines.
|
| RemoveInvoicePeriod |
Removes a 'Period' entry.
Period (ASBIE). An association to period(s) to which the Invoice applies.
|
| RemoveNote |
Removes a 'Note' entry.
Note (BBIE). Free-form text applying to the Invoice. This element may contain notes or any other similar information that is not contained explicitly in another structure.
|
| RemoveOriginatorDocumentRef |
Removes a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Originator Document.
|
| RemovePaymentMeans |
Removes a 'Payment Means' entry.
Payment Means (ASBIE). An association to Payment Means.
|
| RemovePaymentTerms |
Removes a 'Payment Terms' entry.
Payment Terms (ASBIE). An association to Payment Terms.
|
| RemovePrepaidPayment |
Removes a 'Payment' entry.
Payment (ASBIE). An association to prepaid payment(s).
|
| RemoveReceiptDocumentRef |
Removes a 'Document Reference' entry.
Document Reference (ASBIE). An associative reference to Receipt Advice.
|
| RemoveSignature |
Removes a 'Signature' entry.
Signature (ASBIE). An association to Signature.
|
| RemoveTaxTotal |
Removes a 'Tax Total' entry.
Tax Total (ASBIE). An association to tax total for specific tax types/rates.
|
| ResetAccountingCost |
Resets the node.
|
| ResetAccountingCostCode |
Resets the node.
|
| ResetAccountingCustomerParty |
Resets the node.
|
| ResetAccountingSupplierParty |
Resets the node.
|
| ResetCopyIndicator |
Resets the node.
|
| ResetCustomizationID |
Resets the node.
|
| ResetDocumentCurrencyCode |
Resets the node.
|
| ResetID |
Resets the node.
|
| ResetInvoiceTypeCode |
Resets the node.
|
| ResetLegalMonetaryTotal |
Resets the node.
|
| ResetLineCountNumeric |
Resets the node.
|
| ResetOrderReference |
Resets the node.
|
| ResetPayeeParty |
Resets the node.
|
| ResetPaymentAlternativeCurrencyCode |
Resets the node.
|
| ResetPaymentAlternativeExchangeRate |
Resets the node.
|
| ResetPaymentCurrencyCode |
Resets the node.
|
| ResetPaymentExchangeRate |
Resets the node.
|
| ResetPricingCurrencyCode |
Resets the node.
|
| ResetPricingExchangeRate |
Resets the node.
|
| ResetProfileID |
Resets the node.
|
| ResetShipment |
Resets the node.
|
| ResetTaxCurrencyCode |
Resets the node.
|
| ResetTaxExchangeRate |
Resets the node.
|
| ResetTaxRepresentativeParty |
Resets the node.
|
| ResetUBLExtensions |
Resets the node.
|
| ResetUBLVersionID |
Resets the node.
|
| ResetUUID |
Resets the node.
|
| SetDocument |
Sets the document from an object. The object can be a string or
a binary array.
|
| SetOutputEncoding |
Sets the desired output encoding. An empty string resets it to its default (normally UTF-8).
|
| Write |
Writes the document to file.
|
Properties
| Name | Description | |
|---|---|---|
 | AccountingCost |
Accounting Cost (BBIE). The Buyer's accounting code applied to the Invoice as a whole, expressed as text.
|
| AccountingCostCode |
Accounting Cost Code (BBIE). The Buyer's accounting code applied to the Invoice as a whole.
|
| AccountingCostCodeSet |
Checks if the property has been set or not.
|
| AccountingCostSet |
Checks if the property has been set or not.
|
| AccountingCustomerParty |
Customer Party (ASBIE). An association to the Accounting Buyer Party.
|
| AccountingCustomerPartySet |
Checks if the property has been set or not.
|
| AccountingSupplierParty |
Supplier Party (ASBIE). An association to the Accounting Supplier Party.
|
| AccountingSupplierPartySet |
Checks if the property has been set or not.
|
| CopyIndicator |
Indicator (BBIE). Indicates whether a document is a copy (true) or not (false).
|
| CopyIndicatorSet |
Checks if the property has been set or not.
|
| CustomizationID |
Customization Identifier (BBIE). Identifies a user-defined customization of UBL for a specific use.
|
| CustomizationIDSet |
Checks if the property has been set or not.
|
| DocumentCurrencyCode |
Currency Code (BBIE). The currency in which the Document is presented. This may be the same currency as the pricing or as the tax.
|
| DocumentCurrencyCodeSet |
Checks if the property has been set or not.
|
| ID |
Identifier (BBIE). An identifier for the Invoice assigned by the Creditor.
|
| IDSet |
Checks if the property has been set or not.
|
| InvoiceTypeCode |
Invoice Type Code (BBIE). Code specifying the type of the Invoice.
|
| InvoiceTypeCodeSet |
Checks if the property has been set or not.
|
| IssueDate |
Issue Date (BBIE). The date assigned by the Creditor on which the Invoice was issued.
|
| IssueTime |
Issue Time (BBIE). The time assigned by the Creditor at which the Invoice was issued.
|
| LegalMonetaryTotal |
Monetary Total (ASBIE). An association to the total amount payable on the Invoice, including Allowances, Charges, and Taxes.
|
| LegalMonetaryTotalSet |
Checks if the property has been set or not.
|
| LineCountNumeric |
Line Count (BBIE). The number of lines in the document.
|
| LineCountNumericSet |
Checks if the property has been set or not.
|
| NamespaceUri |
Gets the namespace URI of this document.
|
| OrderReference |
Order Reference (ASBIE). An association to Order Reference.
|
| OrderReferenceSet |
Checks if the property has been set or not.
|
| PayeeParty |
Party (ASBIE). An association to the Payee.
|
| PayeePartySet |
Checks if the property has been set or not.
|
| PaymentAlternativeCurrencyCode |
Currency Code (BBIE). The alternative currency used for payment in the Freight Invoice.
|
| PaymentAlternativeCurrencyCodeSet |
Checks if the property has been set or not.
|
| PaymentAlternativeExchangeRate |
Exchange Rate (ASBIE). An association to Exchange Rate between the Document Currency and the Payment Alternative Currency.
|
| PaymentAlternativeExchangeRateSet |
Checks if the property has been set or not.
|
| PaymentCurrencyCode |
Currency Code (BBIE). The currency used for payment in the Freight Invoice.
|
| PaymentCurrencyCodeSet |
Checks if the property has been set or not.
|
| PaymentExchangeRate |
Exchange Rate (ASBIE). An association to Exchange Rate between the Document Currency and the Payment Currency.
|
| PaymentExchangeRateSet |
Checks if the property has been set or not.
|
| PricingCurrencyCode |
Currency Code (BBIE). The currency used for prices in the Freight Invoice.
|
| PricingCurrencyCodeSet |
Checks if the property has been set or not.
|
| PricingExchangeRate |
Exchange Rate (ASBIE). An association to Exchange Rate between the Document Currency and the Pricing Currency.
|
| PricingExchangeRateSet |
Checks if the property has been set or not.
|
| ProfileID |
Profile Identifier (BBIE). Identifies a user-defined profile of the customization of UBL being used.
|
| ProfileIDSet |
Checks if the property has been set or not.
|
| Shipment |
Shipment (ASBIE). An association to Shipment.
|
| ShipmentSet |
Checks if the property has been set or not.
|
| TaxCurrencyCode |
Currency Code (BBIE). The currency used for tax amounts in the Invoice.
|
| TaxCurrencyCodeSet |
Checks if the property has been set or not.
|
| TaxExchangeRate |
Exchange Rate (ASBIE). An association to Exchange Rate between the Document Currency and the Tax Currency.
|
| TaxExchangeRateSet |
Checks if the property has been set or not.
|
| TaxPointDate |
Tax Point Date (BBIE). The date of the Invoice, used to indicate the point at which tax becomes applicable.
|
| TaxRepresentativeParty |
Party (ASBIE). An association to the Tax Representative.
|
| TaxRepresentativePartySet |
Checks if the property has been set or not.
|
| UBLExtensions |
().
|
| UBLExtensionsSet |
Checks if the property has been set or not.
|
| UBLVersionID |
UBL Version Identifier (BBIE). The earliest version of the UBL 2 schema for this document type that defines all of the elements that might be encountered in the current instance.
|
| UBLVersionIDSet |
Checks if the property has been set or not.
|
| UUID |
UUID (BBIE). A universally unique identifier for an instance of this ABIE.
|
| UUIDSet |
Checks if the property has been set or not.
|
See Also
