Skip to main content

CreateInvoiceInput

A new invoice.

input CreateInvoiceInput {
  billingAddress: JSON
  confirmZeroDeliveryCharge: Boolean
  currency: String
  discountAmount: Float
  dueDate: String
  exchangeRate: Float
  internalNotes: String
  invoiceDate: String!
  invoiceNumber: String
  items: [InvoiceItemInput!]!
  notes: String
  orderId: ID
  partnerId: ID!
  paymentTerms: String
  shippingAddress: JSON
  shippingAmount: Float
  supplierCode: String
  supplierDisplayName: String
  supplierEmail: String
  supplierName: String
  supplierPhone: String
  surchargeAmount: Float
  taxAmount: Float
  taxCalculationMethod: String
  terms: String
  type: InvoiceType!
  warehouseId: ID
}

Fields​

CreateInvoiceInput.billingAddress ● JSON scalar​

Billing address, as JSON.

CreateInvoiceInput.confirmZeroDeliveryCharge ● Boolean scalar​

Invoicing a freight-quote sales order (too heavy to price delivery live) whose delivery charge is still unset is refused with DELIVERY_FREIGHT_CHARGE_UNSET. Send true to confirm the order ships with no delivery charge.

CreateInvoiceInput.currency ● String scalar​

ISO 4217 currency code of the invoice.

CreateInvoiceInput.discountAmount ● Float scalar​

Additional invoice-level discount as an amount. Must not be negative.

CreateInvoiceInput.dueDate ● String scalar​

Payment due date, as an ISO 8601 date. When omitted it is the invoice date plus the payment term's days. A date you send is kept as a negotiated date.

CreateInvoiceInput.exchangeRate ● Float scalar​

Exchange rate to the organization's base currency: 1 unit of the invoice currency equals this many base units. Must be greater than zero.

CreateInvoiceInput.internalNotes ● String scalar​

Notes for your team only, not shown to the customer.

CreateInvoiceInput.invoiceDate ● String! non-null scalar​

The invoice date, as an ISO 8601 date.

CreateInvoiceInput.invoiceNumber ● String scalar​

Invoice number. A number is generated when omitted.

CreateInvoiceInput.items ● [InvoiceItemInput!]! non-null input​

The invoice lines.

CreateInvoiceInput.notes ● String scalar​

Notes shown to the customer on the invoice.

CreateInvoiceInput.orderId ● ID scalar​

The ID of the sales order this invoice bills. Must be an order in your organization. Without it the invoice is standalone and goes through the standalone credit check.

CreateInvoiceInput.partnerId ● ID! non-null scalar​

The ID of the customer (sales invoice) or supplier (purchase invoice).

CreateInvoiceInput.paymentTerms ● String scalar​

Payment terms code. Falls back to the customer's default, then the organization's default.

CreateInvoiceInput.shippingAddress ● JSON scalar​

Shipping address, as JSON.

CreateInvoiceInput.shippingAmount ● Float scalar​

Shipping charge. Must not be negative.

CreateInvoiceInput.supplierCode ● String scalar​

Supplier code as it appeared when the invoice was created.

CreateInvoiceInput.supplierDisplayName ● String scalar​

Supplier display name as it appeared when the invoice was created.

CreateInvoiceInput.supplierEmail ● String scalar​

Supplier email as it appeared when the invoice was created.

CreateInvoiceInput.supplierName ● String scalar​

Supplier name as it appeared when the invoice was created.

CreateInvoiceInput.supplierPhone ● String scalar​

Supplier phone as it appeared when the invoice was created.

CreateInvoiceInput.surchargeAmount ● Float scalar​

Surcharge. Must not be negative.

CreateInvoiceInput.taxAmount ● Float scalar​

Total tax on the invoice. Must not be negative.

CreateInvoiceInput.taxCalculationMethod ● String scalar​

Whether prices include or exclude tax: INCLUSIVE or EXCLUSIVE.

CreateInvoiceInput.terms ● String scalar​

Terms and conditions text printed on the invoice. Put the payment term code in paymentTerms, not here.

CreateInvoiceInput.type ● InvoiceType! non-null enum​

SALES_INVOICE to bill a customer, PURCHASE_INVOICE to record a supplier bill.

CreateInvoiceInput.warehouseId ● ID scalar​

The ID of the default warehouse for the invoice.

Member Of​

createInvoice mutation