SyncInvoice schema, example, validation rules, validation stylesheet

SyncInvoice type: SyncInvoice

The purpose of the SyncInvoice is to transmit an invoice from a supplier to a customer. This information is passed in order to keep the customer updated on the number of Invoices they have.

SyncInvoice extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea SyncInvoiceDataArea

Is where the information that the BOD message carries is provided, in this case SyncInvoice. The information consists of a Verb and one or more Nouns. The verb (Sync) indicates the action to be performed on the Noun (Invoice).

SyncInvoiceDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Invoice reference
Sync reference

SyncInvoice Scenario Diagram

Sync schema

Sync type: Sync

The Sync verb is used when the owner of the data is passing or publishing that information or change in information to other software components. This is to be used when the receiver of the SyncBOD does not own the data. This verb is commonly used when mass changes are necessary or when a publish and subscribe mechanism is used in the integration architecture.The purposes of this verb include application integrity and ease of data entry for the business user by enabling a single point of input.

Sync extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
SyncCriteria SyncExpressionCriteria

SyncExpressionCriteria
Structure:
Elements:
Name Type Description
SyncExpression
Attributes:
Name Type Usage Description
action required
expressionLanguage
Enumerations:
Add
Change
Delete
Replace

Invoice schema

Invoice type: Invoice

The Invoice is use to invoice the customer.

Header type: InvoiceHeader

Information that applies to the entire invoice document. The Header supports summary amounts for line items, charges, taxes and allowances. It also supports itemizing Header level charges, taxes and allowances for use in credit or debit invoices. In this case Line items are not needed. The summary amounts in the Header include the Line level amounts and Header level amounts.

Line type: InvoiceLine

In general an Invoice Line can be aligned with Order Lines. The ItemQuantity and Price are used to compute the Total. The TotalAmount is a sum of the Total and any Charges, Taxes or Allowances.

Invoice extends: Order
Structure:

InvoiceHeader extends: OrderHeader

The InvoiceHeader type supports summary amounts for line items, charges and allowances.

Structure:
Elements:
Name Type Description
Allowance reference

Identifies a type of allowance on order related BODs

PaymentMethod PaymentMethod

The method of payment.

Standard values from ISO 10962:2001?

Securities and related financial instruments - Classification of Financial Instruments (CFI code)

Reason Reason

A free form description of the reason for this invoice. Example: Special allowance for preferred customers.

A reason indicator for any type of business event or activity with optional code attribute.

Tax reference

Identifies a type of tax on order related BODs

TotalAllowance Amount

Represents the grand total of all allowances both from line items and header itemizations.

Simple content with the currency as an attrbute

TotalCharges Amount

Represents the grand total of all charges, both from line items and header itemizations.

Simple content with the currency as an attrbute

TotalTax Amount

The grand total of all taxes, both from the line items and header itemizations.

Simple content with the currency as an attrbute

Type InvoiceType

Represents the type of invoice.

The type of invoice

UserArea reference

InvoiceLine extends: OrderLine

The InvoiceLine type supports order line invoicing.

Structure:
Elements:
Name Type Description
Allowance reference

Identifies a type of allowance on order related BODs

ItemQuantity Quantity

The quantity of the item being invoiced.

A decimal value.

Line InvoiceLine

To support complex hirearchical structures an invoice line can contain another invoice line.

Price AmountPerQuantity

The price for the item.

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

ProjectActivity ProjectActivity

The specific business process or task within a project. For example, billing, receiving or preparing purchase orders

The specific business process or task within a project. For example, billing, receiving or preparing purchase orders.

ProjectResource ProjectResource

The categorization of project resources into classes, subclasses, etc.. Examples: Labor Material Equipment

UserArea UserArea

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files

Order.xsd schema

Buyer type: Contact

Is the person(s) or department responsible for purchasing the ordered items from the Customers side.

A business Party contact is a person and has a specific role.

Requester type: Contact

Is the person(s) or department that requested that the ordereditems be purchased from the Customers side.

A business Party contact is a person and has a specific role.

SalesPerson type: Contact

Is the Sales Person(s) that were responsible for the sale from the Supplier's side.

A business Party contact is a person and has a specific role.

Planner type: Contact

Is the person that is responsible for planning when the ordered items are needed from the Customers side. From the Supplier's side the planner will determine when the ordered items can be available.

A business Party contact is a person and has a specific role.

SalesInformation type: SalesInformation

Communicates the information about the sale.

Order restricts: Document
Structure:
Elements:
Name Type Description
Header reference
Line reference

OrderHeader extends: DocumentOrderHeader
Structure:
Elements:
Name Type Description
BackOrderedInd Indicator

Inidicates if the Order is BackOrdered or not.

Indicates if the semantic name is needed or not.

Charges reference
Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

DropShipInd Indicator

Indicates whether the order can be drop shipped or not.

Indicates if the semantic name is needed or not.

EarliestShipDate DateTimeAny

Indicates the earliest ship date for the order.

ExtendedPrice Amount

Indicates the total value of the order line items. It does not include any additional charges or fees.

Simple content with the currency as an attrbute

FreightClass FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

License License

Indicates what type of licenses are required in order to make the sell.

Indicates whether a license is need for a given transaction.

NeedDeliveryDate DateTimeAny

Indicates the date the order needs to be delivered to the customer..

OrderStatus reference
Parties reference
PaymentTerms reference

Identifies the payment terms for an Order or Invoice. Supports the abiility to specify an absolute due date, a number of days from a start daye, a percent discount or an absolute discount. A common term like "Net30Days" is explicitly code as either a calculated DueDateTime or a PaymentTermsDateTime and NumberOfDays.

Priority Priority

Inidicates the Priority that the Customer is requesting for the order.

PromisedDeliveryDate DateTimeAny

Indicates the date in which the order was promised to be delivered to the customer.

PromisedShipDate DateTimeAny

Indicates the date in which the order was promised to be shipped from the supplier to the customer.

ReasonCode ReasonCode

Is used as a reason indicator for any type of business event or activity.

Used as a reason indicator for any type of business event or activity.

ShipNote Note

Is the shipping instructions or notes. This is a free form area that contains special instructions such as: Second Day Air, Hurry, Rush, Handle with Care.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

ShipPriorToDueDateInd Indicator

Indicates if the order can be shipped prior to the dates on the order.

Indicates if the semantic name is needed or not.

SpecialPriceAuthorization AuthorizationId

Is the supplier’s code to authorize special pricing as a result of an agreement.

SYNONYMS: Price Authorization, Price Code

TaxWithholdingExempt TaxWithholdingExempt

Specifies whether the document is exempt from withholding taxes..

TotalAmount Amount

Indicates the total value of the order. It is possible for this to be provided in both the currency of the given transaction or in the default currency of the sending orginization (the functional currency). This is necessary for internal application communication.

Simple content with the currency as an attrbute

TransportationTerm reference

When a seller ships something via common to a buyer in accordance with the Uniform Commerical Code and international legal agreements, you must specify a particular "phrase" that states who assumes the risk of shipment, who is responsible for loading and unloading the goods, where ownership or title to the goods passes, who paid or pays the carrirer, etc. Examples of these "phrases" include: - "FOB Origin Prepaid and Add" (Free On Board - no cost for loading, title passes at seller's dock, seller prepaid freight cost and delivery insurance, seller will freight costs to cost of goods) - "FOB Destination" or "FOB Destination Prepaid" (Free On Board - no cost for loading, title passes at buyer's dock, seller prepaid freight cost and delivery insurance) In software applications, this phrase is commonly split into two coded pieces, a "legal terms" risk and responsibility component for use with common carriers (FOB Destination) and some kind of qualifying component (Prepaid and Add).

OrderLine extends: OrderLineBase
Structure:
Elements:
Name Type Description
Attachments reference
Charges reference
DocumentReferences reference
OrderStatus reference
Parties reference
PaymentTerms reference

Identifies the payment terms for an Order or Invoice. Supports the abiility to specify an absolute due date, a number of days from a start daye, a percent discount or an absolute discount. A common term like "Net30Days" is explicitly code as either a calculated DueDateTime or a PaymentTermsDateTime and NumberOfDays.

Tax reference

Identifies a type of tax on order related BODs

OrderLineBase extends: DocumentLine
Structure:
Elements:
Name Type Description
BackOrderedInd Indicator

Inidicates if the Order is BackOrdered or not.

Indicates if the semantic name is needed or not.

BackOrderedQuantity Quantity

Indicates the number of the ordered quantity placed on back order for the line.

A decimal value.

Description Description

Is a free form description of the line.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

DropShipInd Indicator

Indicates whether the order can be drop shipped or not.

Indicates if the semantic name is needed or not.

EarliestShipDate DateTimeAny

Indicates the earliest ship date for the order line.

ExtendedPrice Amount

Indicates the accumulated cost of the ordered items for this line. It is OrderedQuantity multiplied by the UnitPrce.

Simple content with the currency as an attrbute

FreightClass FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

License License

Indicates what type of licenses are required in order to make the sell.

Indicates whether a license is need for a given transaction.

MaximumTemperature Temperature

Is maximum temperature the Line item can reach.

A temperature value in decimal.

MinimumTemperature Temperature

Is minimum temperature the Line item can reach.

A temperature value in decimal.

NeedDeliveryDate DateTimeAny

Indicates the date the order line needs to be delivered to the customer..

OrderItem reference

Provides information on the Orderable Item. When associated with an order like a Purchase Order, it identifies the item being ordered at the associated Line.

OrderQuantity Quantity

Indicates the number of ordered items for the given line..

A decimal value.

PackingMaterial PackingMaterial
Priority Priority

Inidicates the Priority that the Customer is requesting for the order.

PromisedDeliveryDate DateTimeAny

Indicates the date in which the order line was promised to be delivered to the customer.

PromisedShipDate DateTimeAny

Indicates the date in which the order line was promised to be shipped from the supplier to the customer.

ReasonCode ReasonCode

Is used as a reason indicator for any type of business event or activity.

Used as a reason indicator for any type of business event or activity.

ShipNote Note

Is the shipping instructions or notes. This is a free form area that contains special instructions such as: Second Day Air, Hurry, Rush, Handle with Care.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

ShipPriorToDueDateInd Indicator

Indicates if the semantic name is needed or not.

SubstitutionAllowedInd Indicator

Indicates if the semantic name is needed or not.

TaxWithholdingExempt TaxWithholdingExempt

Specifies whether the item is exempt from withholding taxes..

TotalAmount Amount

Indicates the total cost of the ordered items for this line.This includes any additional charges or handling fees.

Simple content with the currency as an attrbute

TransportationTerm reference

When a seller ships something via common to a buyer in accordance with the Uniform Commerical Code and international legal agreements, you must specify a particular "phrase" that states who assumes the risk of shipment, who is responsible for loading and unloading the goods, where ownership or title to the goods passes, who paid or pays the carrirer, etc. Examples of these "phrases" include: - "FOB Origin Prepaid and Add" (Free On Board - no cost for loading, title passes at seller's dock, seller prepaid freight cost and delivery insurance, seller will freight costs to cost of goods) - "FOB Destination" or "FOB Destination Prepaid" (Free On Board - no cost for loading, title passes at buyer's dock, seller prepaid freight cost and delivery insurance) In software applications, this phrase is commonly split into two coded pieces, a "legal terms" risk and responsibility component for use with common carriers (FOB Destination) and some kind of qualifying component (Prepaid and Add).

UnitPrice AmountPerQuantity

Indicates the price per unit of the items ordered.

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

OrderSchedule extends: OrderLineBase
Structure:
Elements:
Name Type Description
EffectivePeriod TimePeriodAny

Is the starting point in time in which the schedule applies.

FixedTimeDuration Duration

Indicates how often a shipment of Order Items are to be sent to the Customer.

OverShipTolerance Quantity

Indicates the number over the RequiredQuantity a given shipment may be.

A decimal value.

OverToleranceDuration Duration

Indicates the number of days late that a shipment of the scheduled items can be.

RequiredQuantity Quantity

Indiactes the quatity of Order Items that are required in for a given shipment for the schedule.

A decimal value.

UnderShipTolerance Quantity

Indicates the number under the RequiredQuantity a given shipment may be.

A decimal value.

UnderToleranceDuration Duration

Indicates the number of days early that a shipment of scheduled items can be.

OrderSubLine extends: OrderLineBase
Structure:
Elements:
Name Type Description
UserArea reference

SalesInformation

Communicates the Sales Information like the sales person, and their commision, indcates the Sales Organizations involved and their commision rates.

Structure:
Elements:
Name Type Description
CommisionQuantity Quantity

Indicates the Quantity of items in which the commision is received for.

A decimal value.

CommissionAmount Amount

Monitary Amount of the commision.

Simple content with the currency as an attrbute

OrderAmount Amount

Is the total Amount of the Order.

Simple content with the currency as an attrbute

OrderQuantity Quantity

Is the total Ordered Quantity.

A decimal value.

PercentQuantity Quantity

Is the Commision Percentage for the Sales Person or Organization.

A decimal value.

SalesOrganization SalesOrganization

Indicates the Sales Organizations involved in the sell.

Idenitifies the SalesOrganizations.

SalesPerson reference

Is the Sales Person that were involved in the order.

UserArea reference

Document.xsd schema

Document extends: Noun
Structure:
Elements:
Name Type Description
Header reference
Line reference

DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentDateTime DateTime

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

Status reference

DocumentLine
Structure:
Elements:
Name Type Description
LineNumber LineNumber

Is the Line Number of the given Line Coponent within the document. LineNumbers are assigned by the sending system.

Identifies the instance of a Line within a given document.

DocumentOrderHeader restricts: DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentDateTime DateTime

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.