Skip to main content

CreatePurchaseOrderInput

Input to create a purchase order.

input CreatePurchaseOrderInput {
  alternativeTaxRate: String
  costTier: String
  deliveryAddress: JSON
  deliveryInstructions: String
  discountAmount: Float!
  exchangeRate: Float!
  expectedDate: DateTime
  freightAmount: Float!
  internalComments: String
  items: [CreatePurchaseOrderItemInput!]!
  metadata: JSON
  notes: String
  orderCurrency: String
  orderDate: String
  paymentTerms: String!
  projectName: String
  receivedBy: String
  shippingAddress: JSON
  shippingAmount: Float!
  sourceSalesOrderId: String
  supplierCode: String
  supplierDisplayName: String
  supplierEmail: String
  supplierId: String!
  supplierName: String
  supplierPhone: String
  surchargeAmount: Float!
  trackingCode: String
  warehouseId: String
}

Fields

`CreatePurchaseOrderInput.alternativeTaxRate` ● `String` scalar

Alternative tax rate applied to the order, when it differs from the per-line rates.

`CreatePurchaseOrderInput.costTier` ● `String` scalar

Cost tier the supplier prices were taken from.

`CreatePurchaseOrderInput.deliveryAddress` ● `JSON` scalar

Address the supplier delivers to, as a JSON address object.

`CreatePurchaseOrderInput.deliveryInstructions` ● `String` scalar

Free-text delivery instructions for the supplier.

`CreatePurchaseOrderInput.discountAmount` ● `Float!` non-null scalar

Order-level discount, in the order currency.

`CreatePurchaseOrderInput.exchangeRate` ● `Float!` non-null scalar

Exchange rate between the order currency and the organization's base currency.

`CreatePurchaseOrderInput.expectedDate` ● `DateTime` scalar

Date the goods are expected to arrive.

`CreatePurchaseOrderInput.freightAmount` ● `Float!` non-null scalar

Freight charge for the order, in the order currency.

`CreatePurchaseOrderInput.internalComments` ● `String` scalar

Comments for your team only; never shown to the supplier.

`CreatePurchaseOrderInput.items` ● `[CreatePurchaseOrderItemInput!]!` non-null input

The lines on the order.

`CreatePurchaseOrderInput.metadata` ● `JSON` scalar

Additional data attached to the record, as JSON.

`CreatePurchaseOrderInput.notes` ● `String` scalar

Notes on the order, visible to the supplier.

`CreatePurchaseOrderInput.orderCurrency` ● `String` scalar

Currency code of the order's amounts.

`CreatePurchaseOrderInput.orderDate` ● `String` scalar

Date the order was placed.

`CreatePurchaseOrderInput.paymentTerms` ● `String!` non-null scalar

Payment terms agreed with the supplier.

`CreatePurchaseOrderInput.projectName` ● `String` scalar

Project the purchase is for, if any.

`CreatePurchaseOrderInput.receivedBy` ● `String` scalar

The ID of the user who received the goods.

`CreatePurchaseOrderInput.shippingAddress` ● `JSON` scalar

Address the order is shipped from or billed to, as a JSON address object.

`CreatePurchaseOrderInput.shippingAmount` ● `Float!` non-null scalar

Shipping charge for the order, in the order currency.

`CreatePurchaseOrderInput.sourceSalesOrderId` ● `String` scalar

The ID of the sales order this purchase order is raised for, if any.

`CreatePurchaseOrderInput.supplierCode` ● `String` scalar

The supplier's code.

`CreatePurchaseOrderInput.supplierDisplayName` ● `String` scalar

The supplier's display name.

`CreatePurchaseOrderInput.supplierEmail` ● `String` scalar

The supplier's email address.

`CreatePurchaseOrderInput.supplierId` ● `String!` non-null scalar

The ID of the supplier.

`CreatePurchaseOrderInput.supplierName` ● `String` scalar

The supplier's legal name.

`CreatePurchaseOrderInput.supplierPhone` ● `String` scalar

The supplier's phone number.

`CreatePurchaseOrderInput.surchargeAmount` ● `Float!` non-null scalar

Surcharge on the order, in the order currency.

`CreatePurchaseOrderInput.trackingCode` ● `String` scalar

Carrier tracking code for the shipment.

`CreatePurchaseOrderInput.warehouseId` ● `String` scalar

The ID of the warehouse.

Member Of

createPurchaseOrder mutation

Fields
Member Of