Invoices
PublishInvoice
Publishes the specified draft invoice.
After an invoice is published, Square follows up based on the invoice configuration. For example, Square sends the invoice to the customer's email address, charges the customer's card on file, or does nothing. Square also makes the invoice available on a Square-hosted invoice page.
The invoice status also changes from DRAFT to a status based on the invoice configuration. For example, the status changes to UNPAID if Square emails the invoice or PARTIALLY_PAID if Square charge a card on file for a portion of the invoice amount.
post/v2/invoices/{invoice_id}/publish
Path parameters
invoice_idstring required
The ID of the invoice to publish.
Request body
Example request
{
"request_body": {
"idempotency_key": "32da42d0-1997-41b0-826b-f09464fc2c2e",
"version": 1
}
}Response
Success
Example response
{
"invoice": {
"accepted_payment_methods": {
"bank_account": false,
"card": true,
"square_gift_card": false
},
"created_at": "2020-06-18T17:45:13Z",
"custom_fields": [
{
"label": "Event Reference Number",
"placement": "ABOVE_LINE_ITEMS",
"value": "Ref. #1234"
},
{
"label": "Terms of Service",
"placement": "BELOW_LINE_ITEMS",
"value": "The terms of service are..."
}
],
"delivery_method": "EMAIL",
"description": "We appreciate your business!",
"id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
"invoice_number": "inv-100",
"location_id": "ES0RJRZYEC39A",
"order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
"payment_requests": [
{
"automatic_payment_source": "NONE",
"computed_amount_money": {
"amount": 10000,
"currency": "USD"
},
"due_date": "2030-01-24",
"reminders": [
{
"message": "Your invoice is due tomorrow",
"relative_scheduled_days": -1,
"status": "PENDING",
"uid": "beebd363-e47f-4075-8785-c235aaa7df11"
}
],
"request_type": "BALANCE",
"tipping_enabled": true,
"total_completed_amount_money": {
"amount": 0,
"currency": "USD"
},
"uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
}
],
"primary_recipient": {
"customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
"email_address": "Amelia.Earhart@example.com",
"family_name": "Earhart",
"given_name": "Amelia",
"phone_number": "1-212-555-4240"
},
"public_url": "https://squareup.com/pay-invoice/inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
"scheduled_at": "2030-01-13T10:00:00Z",
"status": "SCHEDULED",
"timezone": "America/Los_Angeles",
"title": "Event Planning Services",
"updated_at": "2020-06-18T18:23:11Z",
"version": 1
}
}