On This Page

Required Fields for Drafting an Invoice

This section lists the required fields necessary to create these types of invoices:
  • In-person draft invoice
  • Email draft invoice
  • Itemized email draft invoice
The invoice created using these fields and specified values is not immediately sent to the customer.

Required Fields for Drafting an In-Person Invoice

invoiceInformation.deliveryMode
Set to one of these possible values to determine whether or not the invoice is emailed to the customer when you send a send invoice request:
  • email
    : An invoice email is sent to the customer when you send the follow-on send invoice request for this invoice draft. The invoice status updates to
    SENT
    .
  • none
    : When you process a follow-on send invoice request to publish the drafted invoice, the invoice is not sent in an email to the customer. To share the invoice with the customer, send the customer the redirect URL in the
    invoiceInformation.paymentLink
     response field. The invoice updates change to
    CREATED
    .
invoiceInformation.description
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.

Required Fields for Drafting an Email Invoice

customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode
Set to
email
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.

Required Fields for Drafting an Invoice with Line Items

customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode
Set to one of these possible values to determine whether or not the invoice will be emailed to the customer when you send a send invoice request:
  • email
    : An invoice email is sent to the customer when you send the follow-on send invoice request for this invoice draft. The invoice status will change to
    SENT
    .
  • none
    : When you process a follow-on send invoice request to publish the drafted invoice, the invoice is not sent in an email to the customer. To share the invoice with the customer, send the customer the redirect URL in the
    invoiceInformation.paymentLink
     response field. The invoice status will change to
    CREATED
    .
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.
orderInformation.lineItems[].productSku