Invoices
UpdateInvoice
Updates an invoice by modifying fields, clearing fields, or both. For most updates, you can use a sparse Invoice object to add fields or change values and use the fields_to_clear field to specify fields to clear. However, some restrictions apply. For example, you cannot change the order_id or location_id field and you must provide the complete custom_fields list to update a custom field. Published invoices have additional restrictions.
put/v2/invoices/{invoice_id}
Path parameters
invoice_idstring required
The ID of the invoice to update.
Request body
Example request
{
"request_body": {
"fields_to_clear": [
"payments_requests[2da7964f-f3d2-4f43-81e8-5aa220bf3355].reminders"
],
"idempotency_key": "4ee82288-0910-499e-ab4c-5d0071dad1be",
"invoice": {
"payment_requests": [
{
"tipping_enabled": false,
"uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
}
]
}
}
}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",
"next_payment_amount_money": {
"amount": 10000,
"currency": "USD"
},
"order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
"payment_requests": [
{
"automatic_payment_source": "NONE",
"computed_amount_money": {
"amount": 10000,
"currency": "USD"
},
"due_date": "2030-01-24",
"request_type": "BALANCE",
"tipping_enabled": false,
"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"
},
"scheduled_at": "2030-01-13T10:00:00Z",
"status": "UNPAID",
"timezone": "America/Los_Angeles",
"title": "Event Planning Services",
"updated_at": "2020-06-18T18:23:11Z",
"version": 2
}
}