Manage Invoices Using the Invoices API
The Square invoices platform enables sellers to request or automatically collect payments from their customers. Sellers can use the Square Seller Dashboard or mobile applications (Square Point of Sale and Square Invoices) to create and manage invoices. In addition to these first-party applications, developers can use the Invoices API to integrate Square invoices into third-party applications.
On this page
Overview
Managing invoices can be hard, but integrating the Invoices API into your application flow helps to simplify the experience and reduce your application development costs:
Square follows up with customers for the invoices you create, so you do not need to collect payments or send invoices, reminders, and receipts. Depending on the invoice settings you specify, Square can automatically email the invoice or charge a card on file, even when invoices are split into multiple payment requests.
Square generates and hosts a web page where customers can easily pay the invoice. After each payment, Square sends a receipt to the customer and updates the invoice status as needed.
The Invoices API requires an order ID and a customer ID to create and publish an invoice. This enables built-in integration with the Orders API and Customers API. For example, the Invoices API ensures that the invoice payment requests are equal to the total order amount and retrieves the customer's email address from the customer profile.
All invoices can be managed using the Invoices API or first-party Square applications. However, note the following:
To create an invoice with the Invoices API, the associated order must be created with the Orders API. You cannot use orders created from first-party Square applications because they do not include an order ID, which is required by the
CreateInvoiceendpoint.Invoices created from first-party applications do not include an
order_idfield unless a payment has been made on the invoice.
You can subscribe to webhooks to receive notifications about invoice events.
How it works
The following high-level steps represent a typical workflow for using Square APIs to create an invoice:
Create an order by calling
CreateOrderin the Orders API. Only orders created with the Orders API are supported.Get the customer ID of the invoice recipient. If the order includes a
customer_id, you can use the same customer ID or specify a different one.Create a draft invoice by calling
CreateInvoicein the Invoices API.Publish the invoice by calling
PublishInvoicein the Invoices API. TheInvoiceobject in the response includes the URL of the invoice page where customers can view the invoice and make a payment, if required.For more information, including additional requirements, see Create and publish an invoice.
After you publish the invoice, Square handles the remaining workflow based on the invoice settings. For example, you can direct Square to email the invoice or charge a customer's card on file. You can also direct Square to take no action if you or the seller want to follow up with the customer directly. Square takes no action on draft invoices.
Square manages payments that are charged to a card on file or initiated by customers from the invoice page. Square also updates the invoice payment status and sends reminders and receipts.
No other direct action is required from the developer, unless you need to update the invoice or cancel the invoice.
The following sections explain the Invoices API.
Invoice object
The core of the Square Invoices API is the Invoice type. Consider the following sample invoice requesting a single payment of $12 by the due date from a customer:
{
"invoice": {
"id": "s0XFqYEBhBWDYERexample",
"version": 0,
"location_id": "S8GWD5example",
"order_id": "4NuiKTlFzWmbLnRz9YfoL8example",
"payment_requests": [
{
"uid": "83c2716e-f859-4d75-a015-77489example",
"request_method": "EMAIL",
"request_type": "BALANCE",
"due_date": "2020-05-27",
"computed_amount_money": {
"amount": 1200,
"currency": "USD"
},
"total_completed_amount_money": {
"amount": 0,
"currency": "USD"
}
}
],
"invoice_number": "000020",
"title": "Downtown Print Shop",
"status": "DRAFT",
"timezone": "Etc/UTC",
"created_at": "2020-05-26T15:40:34Z",
"updated_at": "2020-05-26T15:40:34Z",
"primary_recipient": {
"customer_id": "HXJKX5BBKGWX34XEMS2example",
"given_name": "John",
"family_name": "Doe",
"email_address": "doe@email.com"
},
"custom_fields": [
{
"label": "Rules",
"value": "You must agree to the following terms and conditions ...",
"placement": "ABOVE_LINE_ITEMS"
},
{
"label": "Refund Policy",
"value": "Refunds will be made on the original payment method ...",
"placement": "ABOVE_LINE_ITEMS"
}
]
}
}
Some highlights of the invoice object are:
You create one invoice for each order:
The invoice location must match the order location.
The invoice amount sum of
computed_amount_moneyin all payment requests equals thetotal_moneyof the order.
payment_requestsdescribes a payment schedule. This example shows one payment request for the full order amount.primary_recipientis the customer responsible for the invoice. You only specify the customer ID when creating an invoice. The rest of the information is taken from the customer profile in the seller's Customer Directory. Note that the person receiving the invoice can be different from the person who placed the order.statusindicates that the invoice is a DRAFT. You must publish the draft invoice for the customer to receive the invoice. You must also publish invoices that are scheduled to be processed at a later date.invoice_numberis a user-friendly string that displays on the invoice. You might use the invoice number for client-side operations. If you do not provide a value, Square assigns one. Do not confuse this field with the Square-assigned invoiceidused for requests to the Invoices API.versionis 0 because it is the first version of the invoice. Square increments this field each time the invoice changes. You must provide the current version of the invoice forPublishInvoice,UpdateInvoice,CancelInvoice, andDeleteInvoicerequests. You cannot perform actions on previous versions of the invoice.custom_fieldscan contain up to two customer-facing, seller-defined custom fields.
For more information, including additional requirements, see Create and publish an invoice.
Payment requests
In the preceding example invoice, payment_requests specifies one payment request (see InvoicePaymentRequest) for the balance amount (the total_money as specified in the order). You can optionally split the invoice into multiple payment requests. For example, you can:
Request a deposit and request the balance payment at a later date.
Request a deposit and request payments in installments.
Request the payment in installments.
An invoice supports the following payment request combinations:
1 balance
1 deposit with 1 balance
2–12 installments
1 deposit with 2–12 installments
Each of these payment requests must specify the same request_method, which is how you want Square to process the payment request. Consider the following example invoices:
Invoice with two payment requests (a deposit followed by the balance request). Suppose you want to request a 50% deposit and the remaining 50% balance at a later date. An example
payment_requestsobject is shown:... "payment_requests": [ { "request_method":"EMAIL", "request_type":"DEPOSIT", "due_date":"2030-02-01", "percentage_requested":"50" }, { "request_method":"EMAIL", "request_type":"BALANCE", "due_date":"2030-03-01" } ] ...The first DEPOSIT payment request indicates 50% of the total amount on the order. Therefore, the balance is for the remaining amount and is not explicitly specified.
Invoice with three payment requests (a deposit followed by two installments). Suppose you want to request a 50% deposit and the balance paid in two equal installments. An example
payment_requestsobject shows the payment schedule:... "payment_requests": [ { "request_method":"EMAIL", "request_type":"DEPOSIT", "due_date":"2030-02-01", "percentage_requested":"50" }, { "request_method":"EMAIL", "request_type":"INSTALLMENT", "percentage_requested":"50", "due_date":"2030-03-01" }, { "request_method":"EMAIL", "request_type":"INSTALLMENT", "percentage_requested":"50", "due_date":"2030-04-01" } ] ...Note that the 50% in the installments refers to the amount after the deposit is paid. Suppose the order is for $100. This invoice then requests a $50 deposit, followed by two installments of $25 each. Instead of percentages, you can specify exact amounts in
payment_requests:... "payment_requests": [ { "request_method":"EMAIL", "request_type":"DEPOSIT", "due_date":"2020-07-30", "fixed_amount_requested_money":{ "amount":5000, "currency":"USD" } }, { "request_method":"EMAIL", "request_type":"INSTALLMENT", "fixed_amount_requested_money":{ "amount":2500, "currency":"USD" }, "due_date":"2020-08-30" }, { "request_method":"EMAIL", "request_type":"INSTALLMENT", "fixed_amount_requested_money":{ "amount":2500, "currency":"USD" }, "due_date":"2020-09-30" } ] ...
Note the following requirements when specifying a payment schedule:
The sum of the amounts in
payment_requestsmust equal the order amount, which is specified in thetotal_moneyfield of the order.The
request_methodmust be the same for all payment requests:Request method Directs Square to: EMAIL Email the invoice requesting the customer to pay. CHARGE_CARD_ON_FILE Charge the customer's card on file, which is specified by the card_idfield.
To get the card ID, use thecustomer_idof the invoice recipient to call RetrieveCustomer in the Customers API. Then, get the ID of the target card from thecardsfield in the response.CHARGE_BANK_ON_FILE Initiate a transfer from the bank account on file, which is provided by the customer during the payment flow.
This request method is read-only from the Invoices API. It applies only to recurring invoices that sellers create in the Seller Dashboard or other Square first-party application.SHARE_MANUALLY Do nothing. In this case, the seller or the application developer processes the invoice.
Custom fields
You can use the Invoices API to add up to two custom fields to an invoice, each of which can be placed above or below the line items on the invoice. This enables sellers to customize their invoices by adding information such as their terms of service or a refund policy. Custom fields are visible to sellers and buyers on the invoice Square-hosted invoice page and in emailed or PDF copies of invoices. They also display in the details pane of the invoice in the Seller Dashboard.
For example, this invoice includes a "Special Offer" custom field above the invoice line items and an "Arrival instructions" field below the invoice line items.
The following CreateInvoice request creates the invoice shown in the preceding example.
The following considerations apply to custom fields:
If two custom fields use the same placement above or below line items, the custom fields are rendered in the order that they are specified.
In the
textfield, you can use\nto render a new line. No other formatting characters are supported.You cannot use the Invoices API to store custom fields for an account. If you want to enable sellers to reuse custom fields for their invoices, you must define your own storage mechanism.
The Invoices API does not support sparse updates for custom fields. To update a custom field, you must provide the complete
custom_fieldslist in the update request. For more information, see Update custom fields.
Manage invoices
This section explains how you use the Invoices API to create and manage invoices for orders created using the Orders API.
Create and publish an invoice
Creating an invoice is a two-step process: first create a draft invoice and then publish it. Only after you publish the invoice does Square process it. For example, Square can email an invoice to the customer or charge the customer's card on file. You must also publish an invoice that you want to schedule for processing.
To create and publish an invoice, you must provide the following information:
The
order_idof the associated order. An invoice can be associated with one order only.The order must be created using the Orders API.
The order cannot be associated with another invoice.
The order status must be OPEN.
The
location_idof the invoice.The
location_idof the invoice must match thelocation_idof the order.The location status must be ACTIVE.
The
customer_idof the invoice recipient. The customer who creates the order and who receives the invoice can be different.The customer profile must exist in the seller's Customer Directory.
The customer profile must have a valid email address if the invoice is delivered by email, which includes invoices configured for automatic payments. Square uses this email address to send invoices, reminders, and receipts to the customer.
Note
After an invoice is created, the Invoices API does not update the contact information of the recipient if the name, phone number, or email address changes in the associated customer profile.
The Invoices API does update the
customer_idof the recipient if the customer profile is merged.The
payment_requestsfor the invoice, with one or more payment requests that equal thetotal_moneyof the order. The Invoices API computes percentage-based payment amounts based on thetotal_moneyin the payment request schedule. For more information, see Payment requests.
Step 1: Create a draft invoice
You call CreateInvoice to create a draft invoice as shown:
The request body provides the invoice details. In this example, the payment_requests field specifies one payment request (of type BALANCE) for the total order amount, due by the specified due date. In response, the Invoices API returns an invoice with status set to DRAFT.
You can also set a reminder on a payment request. The following CreateInvoice request directs Square to send a reminder to the customer one day before the due date. If the invoice is paid, Square does not send a reminder.
For more CreateInvoice request examples, see Example Walkthrough: Create and Publish Invoices.
Step 2: Publish the invoice
You call PublishInvoice to publish the draft invoice. In the request, you provide the invoice ID and current version.
You can get the ID and version from the invoice returned in the CreateInvoice response. You can also call ListInvoices to retrieve the ID and version or call GetInvoice if you have the ID but need to retrieve the version.
The following is an example response:
{
"invoice": {
"id": "gt2zv1z6mnUm1V7example",
"version": 1,
"location_id": "S8GWD5example",
"order_id": "AdSjVqPCzOAQqvTnzy46VLexample",
"payment_requests": [
{
"uid": "ccc0fc9b-c2a5-42a9-836d-92d01example",
"request_method": "EMAIL",
"request_type": "BALANCE",
"due_date": "2020-06-29",
"computed_amount_money": {
"amount": 100,
"currency": "USD"
}
}
],
"invoice_number": "000028",
"title": "My Invoice Title",
"public_url": "https://squareupsandbox.com/pay-invoice/gt2zv1z6mnUm1V7example",
"status": "UNPAID",
"timezone": "Etc/UTC",
"created_at": "2020-05-30T19:01:32Z",
"updated_at": "2020-05-30T19:05:01Z",
"primary_recipient": {
"customer_id": "DJREAYPRBMSSFAB4TGAexample",
"given_name": "John",
"family_name": "Doe",
"email_address": "doe@email.com"
},
"next_payment_amount_money": {
"amount": 100,
"currency": "USD"
}
}
}
After you publish the invoice, Square takes action based on the request_method specified for the payment request. The preceding example directs Square to email the invoice to the customer. Supported request methods are defined in the InvoiceRequestMethod enum.
By default, when you call PublishInvoice, Square processes the invoice immediately as follows:
If the
request_methodisCHARGE_CARD_ON_FILEorCHARGE_BANK_ON_FILE, Square initiates payment on thedue_datespecified for the payment request:If the payment is due on the same day that the invoice is published, Square charges the card on file and emails a receipt to the customer.
If the payment is due at some future date, Square sends an email telling the customer the due date when the card will be charged. When the due date arrives, Square charges the card and emails a receipt to the customer.
If the
request_methodisEMAIL, Square emails the invoice to the customer.
Instead of processing the invoice immediately after it is published, you can optionally direct Square to process the invoice at some future date by adding the scheduled_at parameter in your CreateInvoice request. When the scheduled_at date arrives, Square processes the invoice:
If the
request_methodisCHARGE_CARD_ON_FILEorCHARGE_BANK_ON_FILE, Square initiates payment on thedue_datespecified for the payment request:If the payment
due_dateis the same as thescheduled_atdate (a date you tell Square to process the invoice), Square charges the card on file and emails a receipt to the customer.If the payment
due_dateis some time in the future, Square sends an email telling the customer the due date when the card will be charged. When the due date arrives, Square charges the card and emails a receipt to the customer.
If the
request_methodisEMAIL, Square emails the invoice to the customer.
None of the preceding applies if the request_method is SHARE_MANUALLY, which directs Square to take no action when the invoice is published. In this case, the seller processes the invoice.
Update an invoice
You call UpdateInvoice to update an invoice. You can modify invoice fields, clear invoice fields, or do both.
In the request body, you provide one or both of the following:
A sparse
Invoiceobject that contains only the fields you want to add or change, along with the new values.A
fields_to_cleararray with a comma-separated list of fields to remove.
Note
Updating a custom field is an exception. You must provide the complete custom_fields list to add or change a custom field. For more information, see Update custom fields.
The following restrictions apply to updating an invoice in a DRAFT state:
You cannot update the
order_idorlocation_idfield.
The following restrictions apply to updating a published invoice:
You cannot update the
primary_recipient,order_id, orlocation_idfield.You cannot update an invoice in the PAID, REFUNDED, CANCELED, or FAILED terminal states.
You cannot update an invoice in the PAYMENT_PENDING state. In addition, another payment cannot be initiated for an invoice in this state.
If you update a published invoice, Square republishes the invoice.
You must provide the invoice ID and current version for all UpdateInvoice requests. You can call ListInvoices to retrieve the ID and version, or you can call GetInvoice if you have the ID but need to retrieve the version.
Example 1: Update an invoice number and title
The following UpdateInvoice request updates the title and invoice_number:
If these fields are not previously set, the update operation adds them to the invoice. The invoice version increments each time the invoice is updated.
Example 2: Update payment requests by removing the deposit request
Consider the following draft invoice, which requests a deposit payment and a balance payment due at a later date.
{
"invoice":{
"id":"bn9CXYfwPZh6Ednexample",
"version":0,
"location_id":"S8GWD5example",
"order_id":"81b7Ar7KPHmlXHs2qhjMc5example",
"payment_requests":[
{
"uid":"a17ee758-fb36-4226-a535-95916example",
"request_method":"CHARGE_CARD_ON_FILE",
"request_type":"DEPOSIT",
"due_date":"2020-06-15",
"percentage_requested":"20",
"card_id":"ccof:aD1D4q9aUXTkexample",
"computed_amount_money":{
"amount":100,
"currency":"USD"
},
"total_completed_amount_money":{
"amount":0,
"currency":"USD"
}
},
{
"uid":"79e1d50d-6a35-40fc-bfd2-05913example",
"request_method":"CHARGE_CARD_ON_FILE",
"request_type":"BALANCE",
"due_date":"2020-07-01",
"card_id":"ccof:aD1D4q9aUXTkexample",
"computed_amount_money":{
"amount":400,
"currency":"USD"
},
"total_completed_amount_money":{
"amount":0,
"currency":"USD"
}
}
],
"invoice_number":"000034",
"status":"DRAFT",
"timezone":"Etc/UTC",
"created_at":"2020-06-10T18:49:06Z",
"updated_at":"2020-06-10T18:49:06Z",
"primary_recipient":{
"customer_id":"DJREAYPRBMSSFAB4TGAexample",
"given_name":"John",
"family_name":"Doe",
"email_address":"doe@email.com"
}
}
}
Suppose you want to remove the deposit payment request from the preceding invoice. The request body in the following request includes the fields_to_clear field, which specifies payment_requests[79e1d50d-6a35-40fc-bfd2-05913example] as the field to remove. The uid index value for payment_requests identifies the specific payment request to remove.
The updated draft invoice is shown, which now requests only one payment in full (no deposit):
{
"invoice":{
"id":"bn9CXYfwPZh6Ednexample",
"version":1,
"location_id":"S8GWD5example",
"order_id":"81b7Ar7KPHmlXHs2qhjMc5example",
"payment_requests":[
{
"uid":"79e1d50d-6a35-40fc-bfd2-05913example",
"request_method":"CHARGE_CARD_ON_FILE",
"request_type":"BALANCE",
"due_date":"2020-07-01",
"card_id":"ccof:aD1D4q9aUXTkexample",
"computed_amount_money":{
"amount":500,
"currency":"USD"
},
"total_completed_amount_money":{
"amount":0,
"currency":"USD"
}
}
],
"invoice_number":"000034",
"status":"DRAFT",
"timezone":"Etc/UTC",
"created_at":"2020-06-10T18:49:06Z",
"updated_at":"2020-06-10T20:28:50Z",
"primary_recipient":{
"customer_id":"DJREAYPRBMSSFAB4TGexample",
"given_name":"John",
"family_name":"Doe",
"email_address":"doe@email.com"
}
}
}
Example variation: Remove the deposit request and change the balance due date
Now consider the following variation. Suppose you want to remove the deposit payment request and also change the due date of the remaining balance payment request. In other words, you want to remove one payment request and update another.
In this case, the UpdateInvoice request body must include:
A
payment_requestsfield in theinvoiceobject that specifies theuidof the payment request to update, along with the new value for thedue_datefield.The
fields_to_clearfield that specifies theuidof the payment request to remove.
Example 3: Remove and add payment requests
The following UpdateInvoice request removes an existing payment request and adds two new payment requests:
Note the following:
fields_to_clearidentifies the specific payment request to remove by providing itsuidvalue.invoicespecifiespayment_requestswithout referring to any existinguidvalue. Therefore, the Invoices API adds these payment requests. If you added auidvalue to any of these payment requests, it would indicate you wanted to update the values of an existing payment request.
Example 4: Replace payment request percentages with exact amounts
Consider the following draft invoice that has two payment requests: a deposit of 20% and the remaining balance due at a later date. Here is an excerpt of the invoice:
{
"invoice": {
"id": "lsBlUr0vkDIu_mAexample",
"version": 0,
"location_id": "S8GWD5example",
"order_id": "8tXvK5qwjkEPbeLixWaKSxexample",
"payment_requests": [
{
"uid": "32d69642-1614-4d84-ae4a-75d51example",
"request_method": "EMAIL",
"request_type": "DEPOSIT",
"due_date": "2020-06-22",
"percentage_requested": "20",
"computed_amount_money": {
"amount": 100,
"currency": "USD"
},
"total_completed_amount_money": {
"amount": 0,
"currency": "USD"
}
},
{
"uid": "622a0315-e640-4a7a-9763-87461example",
"request_method": "EMAIL",
"request_type": "BALANCE",
"due_date": "2020-09-01",
"computed_amount_money": {
"amount": 400,
"currency": "USD"
},
"total_completed_amount_money": {
"amount": 0,
"currency": "USD"
}
}
],
...
}
}
Now suppose you want to specify the exact amount for these payment requests instead of percentages. These are two distinct updates to the same payment request:
Add a new
fixed_amount_requested_moneyfield.Remove the
percentage_requestedfield.
The following UpdateInvoice request performs both of these updates:
Both invoice and fields_to_clear specify the same uid value. As a result, the specified update is applied to the same payment request:
invoiceadds thefixed_amount_requested_moneyfield.fields_to_clearremoves thepercentage_requestedfield.
The updated invoice is shown:
{
"invoice": {
"id": "lsBlUr0vkDIu_mAexample",
"version": 1,
"location_id": "S8GWD5example",
"order_id": "8tXvK5qwjkEPbeLixWaKSxexample",
"payment_requests": [
{
"uid": "32d69642-1614-4d84-ae4a-75d51example",
"request_method": "EMAIL",
"request_type": "DEPOSIT",
"due_date": "2020-06-22",
"fixed_amount_requested_money": {
"amount": 100,
"currency": "USD"
},
"computed_amount_money": {
"amount": 100,
"currency": "USD"
},
"total_completed_amount_money": {
"amount": 0,
"currency": "USD"
}
},
{
"uid": "622a0315-e640-4a7a-9763-87461example",
"request_method": "EMAIL",
"request_type": "BALANCE",
"due_date": "2020-09-01",
"computed_amount_money": {
"amount": 400,
"currency": "USD"
},
"total_completed_amount_money": {
"amount": 0,
"currency": "USD"
}
}
],
...
}
Example 5: Update custom fields
Unlike other invoice fields, the Invoices API does not support using sparse updates to add or change custom fields. To make these changes, you must provide the complete custom_fields list in the update request. For example, consider an invoice that includes the following custom fields:
...
"custom_fields": [
{
"label": "Rules",
"value": "You must agree to the following terms and conditions ...",
"placement": "ABOVE_LINE_ITEMS"
},
{
"label": "Refund Policy",
"value": "Refunds will be made on the original payment method ...",
"placement": "ABOVE_LINE_ITEMS"
}
]
...
If you want to change the label from "Rules" to "Terms and Conditions", the invoice object in the request must include complete definitions for both custom fields. For example:
Omitting a custom field object or field from the request removes the object or field, or returns an error if the field is required. However, you can use the fields_to_clear field if you want to remove all custom fields from the invoice. For example:
Cancel an invoice
You call CancelInvoice to cancel a published invoice. When you cancel an invoice, Square does the following:
Sends an email notification to the customer.
Sets the
statusof the invoice to CANCELED.Sets the
stateof the associated order to CANCELED.Stops any automatic scheduled actions, such as emailing reminders or charging a card on file. Sellers cannot collect payments for a canceled invoice.
The following is an example CancelInvoice request. You must provide the invoice ID and current version for all CancelInvoice requests. You can call ListInvoices to retrieve the ID and version, or call GetInvoice if you have the ID but need to retrieve the version.
The canceled invoice is returned in the response, as shown in the following example excerpt:
{
"invoice": {
"id": "gt2zv1z6mnUm1V7example",
"version": 2,
"location_id": "S8GWD5example",
"order_id": "AdSjVqPCzOAQqvTnzy46VLexample",
...
"status": "CANCELED",
...
}
}
You cannot cancel invoices in the DRAFT state or in the PAID, REFUNDED, CANCELED, or FAILED terminal states. Canceled invoices remain accessible in the seller account. The GetInvoice, ListInvoices, and SearchInvoices requests return canceled invoices.
Delete an invoice
You call DeleteInvoice to delete a draft invoice. You cannot delete published invoices, including those scheduled for processing at a later time. Deleted invoices are removed from the account and are not returned by GetInvoice, ListInvoices, or SearchInvoices requests.
When you delete a draft invoice, Square changes the state of the associated order to CANCELED.
The following is an example DeleteInvoice request. You must provide the invoice ID and current version for all DeleteInvoice requests. You can call ListInvoices to retrieve the ID and version or call GetInvoice if you have the ID but need to retrieve the version.
The following is an example response:
{}
Retrieve an invoice
Use the GetInvoice, ListInvoices, or SearchInvoices endpoint to retrieve invoices. You can retrieve a specific invoice, list invoices at a location, and search for invoices at a specific location for a specific customer:
Get an invoice by ID
Call GetInvoice if you know the invoice ID.
List invoices
Call ListInvoices to retrieve invoices at a specific location. The following example specifies a maximum page size of three results. The default page size is 100.
The following is an excerpt of an example paged response:
{
"invoices": [
{
"id": "avWaZewQ42Np4PCexample",
...
},
{
"id": "7OXWh6-VEakBWtUexample",
...
},
{
"id": "VnxeTa-xrHPNz0Aexample",
...
}
],
"cursor": "PNEhVUKHBuTOuRIZoUcX5VQexample"
}
When a response is truncated, the response includes a cursor to use in the next ListInvoices call. You add the cursor query parameter in the request as shown:
Search invoices
Call SearchInvoices to retrieve invoices that match a specific query. You must provide a location ID, and you can optionally include a customer ID if you want to retrieve invoices for a specific customer at the specified location.
The following example request filters by a specific customer and location. In the current implementation, the SearchInvoices endpoint supports only a single customer ID and a single location ID in the filter.
The following is an excerpt of an example response:
{
"invoices": [
{
"id": "UcPT3fgiZi8lbX3example",
...
},
{
"id": "BSW5ck83F7JoDqIexample",
...
},
...
]
}
The following example request filters by a specific customer and location, and also sorts the results in order from oldest to newest:
The sort field INVOICE_SORT_DATE works as follows:
If the invoice is a draft, it uses the invoice
created_atdate.If the invoice is scheduled for publication, it uses the
scheduled_atdate.If the invoice is published, it uses the invoice publication date.
Refund an invoice
You can call the RefundPayment endpoint in the Refunds API to refund payments.
The invoice status must be PAID, CANCELED, or FAILED to refund a payment. After a refund is processed, the status changes to REFUNDED if the entire amount paid for the invoice is refunded or changes to PARTIALLY_REFUNDED if only a portion of the payment is refunded. Invoices with a status of PARTIALLY_PAID must be canceled using CancelInvoice before they can be refunded.
Sellers can also refund invoice payments using the Square Seller Dashboard or the mobile applications (Square Point of Sale and Square Invoices).
Requirements and limitations
Requirements
The Invoices API requires the following OAuth permissions:
INVOICES_READto use the following endpoints:GetInvoiceListInvoicesSearchInvoices
INVOICES_WRITEandORDERS_WRITEto use the following endpoints:CreateInvoiceUpdateInvoiceDeleteInvoiceCancelInvoicePublishInvoice
CUSTOMERS_READandPAYMENTS_WRITEto charge cards on file.
When creating an invoice, the location that you specify must have an ACTIVE status.
You can send an invoice to a customer only if the customer has a profile in the seller's Customer Directory. For more information about creating customer profiles, see Manage Customers and Integrate with Other Services.
The minimum amount for an invoice payment request is $1.00.
Limitations
An order associated with an invoice has the following restrictions:
Canceling an invoice cancels the order. If you cancel an invoice, the corresponding order is also canceled.
Paying for the order. You can only pay for the order by paying the invoice. You cannot use other Square APIs (such as PayOrder, CreatePayment, and Charge) to process the payment for the order.
Note
However, after customers pay for the invoices, the resulting
Paymentobjects are accessible using the Payments API (GetPaymentandListPayments). The payments also appear in the Seller Dashboard in the Transactions section along with other payments. You can use the Refunds API to refund a payment.Updating an order. You cannot update order fields (such as line items, taxes, and discounts) that change the order amount. To update these order fields, you must cancel the invoice, which also cancels the order (sets the order status to CANCELED). You then create a new order and a new invoice. You can update order fields that do not change the order amount.
When you create an invoice using the Invoices API, the order ID is required. However, an invoice created using the Seller Dashboard, the Square Point of Sale application, or the Square Invoices application is created without an order ID. When you retrieve such an invoice using the Invoices API, the invoice does not include an
order_idfield unless a payment has been made on the invoice.
The Invoices API does not support some of the features available in the Square Seller Dashboard, the Square Point of Sale application, and the Square Invoices application. For example:
Color and logo customization for your email invoices and customer payment page is not supported.
Recurring Invoice Series are not supported.
Estimates are not supported.
Attaching a file to an invoice is not supported. The Invoices API preserves any existing attachments on an invoice but the API does not support accessing and modifying invoice attachments.
Webhooks
The Invoices API supports webhook notifications. For a list invoice events you can subscribe to, see Subscribe to Events.