Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 3.44 KB

Invoice.md

File metadata and controls

28 lines (23 loc) · 3.44 KB
Raw

SquareConnect.Invoice

Description

Note: This model is in beta.

Stores information about an invoice. You use the Invoices API to create and process invoices. For more information, see Manage Invoices Using the Invoices API.

Properties

Name Type Description Notes
id String The Square-assigned ID of the invoice. [optional]
version Number The version number, which is incremented each time an update is committed to the invoice. [optional]
location_id String The ID of the location that this invoice is associated with. This field is required when creating an invoice. [optional]
order_id String The ID of the `order` for which the invoice is created. This order must be in the `OPEN` state and must belong to the `location_id` specified for this invoice. This field is required when creating an invoice. [optional]
primary_recipient InvoiceRecipient The customer who gets the invoice. Square uses the contact information to deliver the invoice. This field is required when creating an invoice. [optional]
payment_requests [InvoicePaymentRequest] An array of `InvoicePaymentRequest` objects. Each object defines a payment request in an invoice payment schedule. It provides information such as when and how Square processes payments. You can specify maximum of nine payment requests. All all the payment requests must specify the same `request_method`. This field is required when creating an invoice. [optional]
invoice_number String A user-friendly invoice number. The value is unique within a location. If not provided when creating an invoice, Square assigns a value. It increments from 1 and padded with zeros making it 7 characters long for example, 0000001, 0000002. [optional]
title String The title of the invoice. [optional]
description String The description of the invoice. This is visible the customer receiving the invoice. [optional]
scheduled_at String The timestamp when the invoice is scheduled for processing, in RFC 3339 format. At the specified time, depending on the `request_method`, Square sends the invoice to the customer's email address or charge the customer's card on file. If the field is not set, Square processes the invoice immediately after publication. [optional]
public_url String 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. [optional]
next_payment_amount_money Money The current amount due for the invoice. In addition to the amount due on the next payment request, this also includes any overdue payment amounts. [optional]
status String The status of the invoice. See InvoiceStatus for possible values [optional]
timezone String The time zone of the date values (for example, `due_date`) specified in the invoice. [optional]
created_at String The timestamp when the invoice was created, in RFC 3339 format. [optional]
updated_at String The timestamp when the invoice was last updated, in RFC 3339 format. [optional]