invoice.md

Invoice

Stores information about an invoice. You use the Invoices API to create and manage invoices. For more information, see Invoices API Overview.

Structure

Invoice

Fields

Name	Type	Tags	Description
id	String	Optional	The Square-assigned ID of the invoice.
version	Integer	Optional	The Square-assigned version number, which is incremented each time an update is committed to the invoice.
location_id	String	Optional	The ID of the location that this invoice is associated with. If specified in a CreateInvoice request, the value must match the location_id of the associated order. Constraints: Minimum Length: 1, Maximum Length: 255
order_id	String	Optional	The ID of the order for which the invoice is created. This field is required when creating an invoice, and the order must be in the OPEN state. To view the line items and other information for the associated order, call the RetrieveOrder endpoint using the order ID. Constraints: Minimum Length: 1, Maximum Length: 255
primary_recipient	Invoice Recipient Hash	Optional	Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice and that Square uses to deliver the invoice. When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates the remaining InvoiceRecipient fields. You cannot update these fields after the invoice is published. Square updates the customer ID in response to a merge operation, but does not update other fields.
payment_requests	Array<Invoice Payment Request Hash>	Optional	The payment schedule for the invoice, represented by one or more payment requests that define payment settings, such as amount due and due date. An invoice supports the following payment request combinations: - One balance - One deposit with one balance - 2–12 installments - One deposit with 2–12 installments This field is required when creating an invoice. It must contain at least one payment request. All payment requests for the invoice must equal the total order amount. For more information, see Configuring payment requests. Adding INSTALLMENT payment requests to an invoice requires an Invoices Plus subscription.
delivery_method	String (Invoice Delivery Method)	Optional	Indicates how Square delivers the invoice to the customer.
invoice_number	String	Optional	A user-friendly invoice number that is displayed on the invoice. The value is unique within a location. If not provided when creating an invoice, Square assigns a value. It increments from 1 and is padded with zeros making it 7 characters long (for example, 0000001 and 0000002). Constraints: Minimum Length: 1, Maximum Length: 191
title	String	Optional	The title of the invoice, which is displayed on the invoice. Constraints: Minimum Length: 1, Maximum Length: 255
description	String	Optional	The description of the invoice, which is displayed on the invoice. Constraints: Minimum Length: 1, Maximum Length: 65536
scheduled_at	String	Optional	The timestamp when the invoice is scheduled for processing, in RFC 3339 format. After the invoice is published, Square processes the invoice on the specified date, according to the delivery method and payment request settings. If the field is not set, Square processes the invoice immediately after it is published.
public_url	String	Optional	The URL of the Square-hosted invoice page. After you publish the invoice using the PublishInvoice endpoint, Square hosts the invoice page and returns the page URL in the response.
next_payment_amount_money	Money Hash	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
status	String (Invoice Status)	Optional	Indicates the status of an invoice.
timezone	String	Optional	The time zone used to interpret calendar dates on the invoice, such as due_date. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed. For example, a payment due_date of 2021-03-09 with a timezone of America/Los_Angeles becomes overdue at midnight on March 9 in America/Los_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).
created_at	String	Optional	The timestamp when the invoice was created, in RFC 3339 format.
updated_at	String	Optional	The timestamp when the invoice was last updated, in RFC 3339 format.
accepted_payment_methods	Invoice Accepted Payment Methods Hash	Optional	The payment methods that customers can use to pay an invoice on the Square-hosted invoice payment page.
custom_fields	Array<Invoice Custom Field Hash>	Optional	Additional seller-defined fields that are displayed on the invoice. For more information, see Custom fields. Adding custom fields to an invoice requires an Invoices Plus subscription. Max: 2 custom fields
subscription_id	String	Optional	The ID of the subscription associated with the invoice. This field is present only on subscription billing invoices.
sale_or_service_date	String	Optional	The date of the sale or the date that the service is rendered, in YYYY-MM-DD format. This field can be used to specify a past or future date which is displayed on the invoice.
payment_conditions	String	Optional	France only. The payment terms and conditions that are displayed on the invoice. For more information, see Payment conditions. For countries other than France, Square returns an INVALID_REQUEST_ERROR with a BAD_REQUEST code and "Payment conditions are not supported for this location's country" detail if this field is included in CreateInvoice or UpdateInvoice requests. Constraints: Minimum Length: 1, Maximum Length: 2000
store_payment_method_enabled	TrueClass | FalseClass	Optional	Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a bank account on file. If true, Square displays a Save my card on file or Save my bank on file checkbox on the invoice payment page. Stored payment information can be used for future automatic payments. The default value is false.
attachments	Array<Invoice Attachment Hash>	Optional	Metadata about the attachments on the invoice. Invoice attachments are managed using the CreateInvoiceAttachment and DeleteInvoiceAttachment endpoints.

Example (as JSON)

{
  "id": "id0",
  "version": 224,
  "location_id": "location_id4",
  "order_id": "order_id4",
  "primary_recipient": {
    "customer_id": "customer_id2",
    "given_name": "given_name6",
    "family_name": "family_name8",
    "email_address": "email_address2",
    "address": {
      "address_line_1": "address_line_16",
      "address_line_2": "address_line_26",
      "address_line_3": "address_line_32",
      "locality": "locality6",
      "sublocality": "sublocality6"
    }
  }
}