Cmdlets for SAP Ariba Procurement

Build 24.0.9060

Orders

Retrieves purchase-order header information.

View-Specific Information

Select

The cmdlet uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The cmdlet processes other filters client-side within the cmdlet.

  • DocumentNumber supports the '=' comparison operator.
  • BuyerANID supports the '=' comparison operator.
  • RoutingStatus supports the '=' comparison operator.
  • OrderStatus support the '=' comparison operator.
  • StartDate and EndDate (when both are specified) supports the '=' comparison operator.

The cmdlet uses the SAP Ariba API to process ORDER BY clause conditions built with the following columns. The cmdlet processes ordering by other columns client-side within the cmdlet.

  • SupplierANID
  • BuyerANID
For example, the following queries are processed server side:
SELECT * FROM Orders WHERE DocumentNumber = 'DO240'

SELECT * FROM Orders WHERE RoutingStatus = 'Sent'

SELECT * FROM Orders WHERE OrderStatus = 'CHANGED'

SELECT * FROM Orders WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'

SELECT * FROM Orders ORDER BY BuyerANID ASC

SELECT * FROM Orders ORDER BY SupplierANID DESC

Columns

Name Type References Description
VendorId String The supplier's vendor ID.
SupplierANID String The supplier's ANID.
SupplierName String The supplier's name.
ServiceId Double Service id.
DisputeId Double Dispute id.
DocumentNumber [KEY] String Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number.
PayloadId String An unique identifier for the document. This is copied directly from the cXML element of the original document.
PoVersion Double Specifies the order version number of change orders, starting with 1 for the original order.
Revision String Revision.
PoClosed Bool Po closed.
Settlement String Method of PO settlement.
IsRelease Bool Indicates whether the orderType is Release.
AttachmentCount Int Attachment count.
SystemId String The customer's system ID.
CustomerANID String The customer's ANID.
CustomerName String The customer's name.
EndPointId String The customer's endpoint ID.
PurchasingOrgCode String The customer's purchasing organization.
PurchasingGroupCode String The customer's purchasing group.
CompanyCode String The customer's buying entity.
BuyerANID String The buyer's ANID.
PurchasingAgentName String Name of contact whose role is purchasing agent.
Blanket Bool Blanket.
BlanketPoId Double Blanket po id.
ReleaseRequired Bool Used only if orderType is blanket, to indicate whether the blanket order requires releases (purchase orders). If yes, is specified, then the blanket order requires separate release orders before the supplier can act. If no, then the supplier can act on the blanket order itself. By default this value is unspecified.
NumberOfInvoices Int Number of invoices.
PaymentTerms String Net Terms or Payment Terms.
PaymentTermsExplanation String Free-form text describing the payment terms for information purposes.
SchedulingAgreement Bool Scheduling agreement.
TransportTerms String The transport information for the shipment described by the order and the ship notice. This information comes from the order specified by the buyer and has to be included in the ship notice, so that these can be edited by the supplier, if required. This information and possible changes have to be carried back to the buyer.
TransportTermsDesc String Transport terms description.
IsoCountryCode String The International Organization for Standardization (ISO) country code for the country in the shipping address.
PoShipToState String The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped.
PoShipToCountry String The Country element is the country where goods are to be shipped.
PoShipToCity String The City element is the city where ordered products are to be shipped.
PoShipToStreet String The Street element is the street address of the ShipTo location where ordered products are to be delivered.
PoShipToCode String Po ship to code.
PoShipToPostalCode String The PostalCode element is the postal or zip code where goods are to be shipped.
DocumentStatus String Document status.
DashboardStatus String Order Status indicates where the order stands with regards to your processing of the order.
RoutingStatus String Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed.
OrderDate Datetime The date and time the order was created.
Created Datetime Date the order was created.
HideAmount Bool An extrinsic that allows you to mask values for the amount.
AmountAvailableConversionDate Datetime Amount available conversion date.
AmountAvailableAmount Decimal Amount available.
AmountAvailableApprox Decimal Amount available approx.
AmountAvailableCurrencyCode String Amount available currency code.
BalanceConversionDate Datetime In case of partially invoiced PO, the balance left on the PO to be invoiced conversion date.
BalanceAmount Decimal In case of partially invoiced PO, the balance left on the PO to be invoiced amount.
BalanceApprox Decimal In case of partially invoiced PO, the balance left on the PO to be invoiced approx.
BalanceCurrencyCode String In case of partially invoiced PO, the balance left on the PO to be invoiced currency code.
InvoicedAmountConversionDate Datetime Invoiced amount conversion date.
InvoicedAmountAmount Decimal Invoiced amount.
InvoicedAmountApprox Decimal Invoiced amount approx.
InvoicedAmountCurrencyCode String Invoiced amount currency code.
PoAmountConversionDate Datetime Total cost of the order conversion date.
PoAmountAmount Decimal Total cost of the order amount.
PoAmountApprox Decimal Total cost of the order approx.
PoAmountCurrencyCode String Total cost of the order currency code.
PoShipToNameKid String For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Kid.
PoShipToNameValue String For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Value.
PoShipToNameEncryptedValue String For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Encrypted value.
OrderStatus String Indicates what state of processing the order has reached.
StartDate Datetime Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.
EndDate Datetime Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060