post
https://api.zenoti.com/v1/invoices//close
This API closes the specified invoice. You can only close an invoice after the total invoice amount has been paid in full (which means that the balance amount of the invoice is zero).
You must provide appropriate data for the invoice_id parameter.
Request Body Details
| Name | Type | Description |
|---|---|---|
| is_invoice_closed | boolean | If true, it indicates that the invoice was successfully closed. |
| error | object | Object that contains error message and error code details. For more information, refer to the error table below. |
| status | enum | Indicates the status of the appointment: NoShow = -2, Cancelled = -1, New = 0, Closed = 1, Checkin = 2, Confirm = 4, Break = 10, NotSpecified = 11, Available = 20, and Voided = 21. |
| closed_by_id | guid | Unique 32 character ID indicating the employee who last closed the invoice. |
error
| Name | Type | Description |
|---|---|---|
| StatusCode | int | Status code that represents the type of the error. |
| Message | string | Message that describes the error. |
| InternalMessage | string | Internal message that describes about the error in more detail. |
Response Details
| Name | Type | Description |
|---|---|---|
| is_invoice_closed | boolean | If true, it indicates that the invoice was successfully closed. |
Error Message Details
| Name | Type | Description |
|---|---|---|
| This invoice has a future appointment and will not be closed. | 1113 | If the invoice contains an appointment for a future date, and it cannot be closed on the current date. |
| Group Invoice Not Supported. | 492 | If the invoice is a Group invoice. You currently cannot close group invoices. |
| Full Payment of invoice is not made. | 419 | If the full payment for the invoice has not been completed, you cannot close the invoice. |
| Payment is made in excess. | 459 | If more payment than the required amount has been paid for the invoice. |
| There are some unassigned tips. You must assign all tips to close the invoice. | 1112 | If some tips have not been assigned as part of the invoice. |
| The loyalty points payments in this invoice exceed the maximum amount you can pay using points. | 459 | If the loyalty points payment that has been added in the invoice exceeds the maximum amount that you can pay by using points. |
| SSG not paid fully. | 419 | If the service charge amount has not been fully paid for the invoice. |
| Invoice could not be closed. | 719 | If it was not possible to close the invoice. |
| Invoice not found. | 428 | If the invoice details could not be found. |