Square Invoices API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Invoices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
10 operations
across 7 paths,
and defines 43 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://connect.squareup.com.
The identity and technical contract details declared by the specification.
Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
GetInvoiceResponse
object
Describes a GetInvoice response.
2 properties
UpdateInvoiceResponse
object
Describes a UpdateInvoice response.
2 properties
InvoiceRecipientTaxIds
object
Represents the tax IDs for an invoice recipient. The country of the seller account determines whether the corresponding taxids field is available for the custo…
1 property
PublishInvoiceRequest
object
Describes a PublishInvoice request.
2 properties
1 required
CreateInvoiceAttachmentRequest
object
Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) request.
2 properties
InvoiceRequestType
string
Indicates the type of the payment request. For more information, see [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-pub…
CreateInvoiceRequest
object
Describes a CreateInvoice request.
2 properties
1 required
Country
string
Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/count…
Money
object
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…
2 properties
UpdateInvoiceRequest
object
Describes a UpdateInvoice request.
3 properties
1 required
InvoicePaymentReminder
object
Describes a payment request reminder (automatic notification) that Square sends to the customer. You configure a reminder relative to the payment request dueda…
5 properties
CancelInvoiceRequest
object
Describes a CancelInvoice request.
1 property
1 required
InvoiceStatus
string
Indicates the status of an invoice.
InvoiceRecipient
object
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…
8 properties
InvoiceCustomField
object
An additional seller-defined and customer-facing field to include on the invoice. For more information, see [Custom fields](https://developer.squareup.com/docs…
3 properties
InvoiceAutomaticPaymentSource
string
Indicates the automatic payment method for an [invoice payment request](entity:InvoicePaymentRequest).
DeleteInvoiceAttachmentResponse
object
Represents a [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) response.
1 property
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
SearchInvoicesResponse
object
Describes a SearchInvoices response.
3 properties
InvoiceCustomFieldPlacement
string
Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF copies of the invoice.
Address
object
Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addr…
14 properties
InvoiceSort
object
Identifies the sort field and sort order.
2 properties
1 required
InvoiceRequestMethod
string
Specifies the action for Square to take for processing the invoice. For example, email the invoice, charge a customer's card on file, or do nothing. DEPRECATED…
DeleteInvoiceResponse
object
Describes a DeleteInvoice response.
1 property
InvoicePaymentReminderStatus
string
The status of a payment request reminder.
InvoicePaymentRequest
object
Represents a payment request for an [invoice](entity:Invoice). Invoices can specify a maximum of 13 payment requests, with up to 12 INSTALLMENT request types.…
13 properties
InvoiceFilter
object
Describes query filters to apply.
2 properties
1 required
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties
2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
ListInvoicesResponse
object
Describes a ListInvoice response.
3 properties
PublishInvoiceResponse
object
Describes a PublishInvoice response.
2 properties
Invoice
object
Stores information about an invoice. You use the Invoices API to create and manage invoices. For more information, see [Invoices API Overview](https://develope…
24 properties
CreateInvoiceAttachmentResponse
object
Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) response.
2 properties
InvoiceAttachment
object
Represents a file attached to an [invoice](entity:Invoice).
7 properties
CancelInvoiceResponse
object
The response returned by the CancelInvoice request.
2 properties
InvoiceAcceptedPaymentMethods
object
The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page.
5 properties
SearchInvoicesRequest
object
Describes a SearchInvoices request.
3 properties
1 required
InvoiceQuery
object
Describes query criteria for searching invoices.
2 properties
1 required
InvoiceSortField
string
The field to use for sorting.
CreateInvoiceResponse
object
The response returned by the CreateInvoice request.
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
InvoiceDeliveryMethod
string
Indicates how Square delivers the [invoice](entity:Invoice) to the customer.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Square publishes across the network.