post https://api.zenoti.com/v1/group_invoices
This API helps you to create a group invoice.
To create a group invoice, you must specify in the API request body the required group_name and invoice_ids details. After you add the required details, this API automatically creates a group invoice.
Request Body Details
| Name | Type | Description |
|---|---|---|
| group_name | string | MandatoryName of the group invoice. |
| invoice_ids | Collection of guid | MandatoryThe collection of invoice IDs that are to be included in the group invoice. |
Response Details
| Name | Type | Description |
|---|---|---|
| is_invoice_created | boolean | If true, it indicates that the API has successfully created the group invoice. |
| group_invoice | object | Object that contains various group invoice-related elements. For more information, refer to the group_invoice Object table. |
| error | object | Object that contains error message and error code details. For more information, refer to the error Object table. |
group_invoice Object
| Name | Type | Description |
|---|---|---|
| Id | guid | Unique 32-character identifier of the group invoice. |
| name | string | Name of the group invoice. |
| host_id | guid | Unique 32-character identifier of the payment host used for payment of the group invoice. |
| payment_made_by | guid | Unique 32-character identifier of the guest who paid the group invoice amount. |
| Invoices | object | Object that contains various invoices-related elements. |
| Redemptions | object | Object that contains various redemptions-related elements. |
| Payments | object | Object that contains various payments-related elements. |
| Price | object | Object that contains various price-related elements. |
| GroupRedemptions | object | Object that contains various group invoice redemptions-related elements. |
error Object
| code | message |
|---|---|
| 502 | Invalid inputs. The invoice_id is not passed. |
| 4001 | This invoice has already been partially paid. |
| 4002 | You’ve already accepted payment for this group invoice. You cannot add any more invoices to this group bill. |
| 4003 | This invoice is part of another group bill and cannot be added to this group bill. |
| 4004 | You cannot add selected invoice, since it has recurring membership. |
| 4005 | You cannot add selected invoice, since it has membership redemption which need One Time Password. |