Invoice Item
- Joel Morgan Kearney (Unlicensed)
- Joel Kearney
These are the endpoints that are available under the /invoiceItem path, which lists all the different invoice items on the invoices on your business' account.
| Endpoint | Description |
|---|---|
| GET /invoiceItem/client/{clientId}/uninvoiced | Returns all invoiceItem objects assigned to specified client that do not have the invoiceId property filled in yet in array format. |
| GET /invoiceItem/product/{productId} | Returns all invoiceItem objects that document the change in stock levels for specified product in array format. |
| GET /invoiceItem/recurringAppointments/{recurringAppointmentId} | Returns all invoiceItem objects for the specified recurring appointment set. |
| GET /appointments/client/{clientId}/uninvoiced | Returns all appointment objects for a client that have not been assigned to an invoice yet in array format. |
| GET /recurringAppointments/client/{clientId}/uninvoiced | Returns all recurringAppointment objects for course sets that client has booked into but have not been invoiced yet in array format. A course set is made up of individual class sessions that all combine to form a course set. If you want to charge someone for their enrollment into the course set, you would need to add an instance of that course set to an invoice. This API is used to find out which course sets a client has booked but not been invoiced for yet. |
GET /invoiceItem/appointment/{calendarId} | Returns all invoiceItem objects for appointments on an invoice in array format. |
| GET /invoiceItemList/reportWithCount | Returns a list of all invoice items on an account in array format. |
| POST /invoiceItems | Creates a new line item on an invoice. Request body/payload: Must pass an array of invoiceItem objects in request body/payload. For these calls, you need to pass an array of invoiceItem objects with all required fields and any fields you want to set filled in the body of the payload. We have an example of an invoiceItem object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| POST /invoiceItem | Creates an invoiceItem object. Request body/payload: Must pass an invoiceiIem object in request body/payload. For these calls, you need to pass an invoiceItem object with all required fields and any fields you want to set filled in the body of the payload. We have an example of an invoiceItem object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| PUT /invoiceItem | Updates an existing invoiceItem object. Request body/payload: Must pass an invoiceItem object in request body/payload-make sure to include the correct invoiceId. For these calls, you need to pass an invoiceItem object with all required fields and any fields you want to update filled in the body of the payload. We have an example of an invoiceItem object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| DELETE /invoiceItem/{invoiceItemId} | Removes an invoiceItem object from view by setting its active property to false. |
Data points passed on in the request URL portion of the API call that are used to filter the data being requested.
| Parameter | Type | Endpoints to be used with | Description |
|---|---|---|---|
| pageNumber | integer | GET /invoiceItemList/reportWithCount | Works with the pageSize parameter to determine how data gets returned following a GET call. The pageNumber value represents the number of pages on which the invoice items that get returned appear. |
| pageSize | integer | Works with the pageNumber parameter to determine how data gets returned following a GET call. The pageSize value represents the number of invoice items appearing on each page of invoice items that gets returned. |
The objects below represent the minimum viable objects to pass that are needed to create or update an invoiceItems or invoiceItem object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
| Property Name | Type | Required | Description |
|---|---|---|---|
| active | boolean | Yes | Indicates whether or not the specified invoice item should return on GET calls. |
| businessId | integer | Yes | Provides unique numerical ID for the business to which the specified invoice item belongs. |
| calendarId | integer | Provides unique numeric ID for the calendar of the appointment from which the specified invoice item was created. | |
| client | object | Displays the client object of any client connected to the specified invoice item - for more info, see Clients API page. | |
| clientId | integer | Yes | Provides unique numeric ID for the client attached to the specified invoice item. |
| coupon | object | Displays the coupon object of any coupon being applied on the specified invoice item - for more info, see Coupon API page. | |
| couponError | string | Displays as the error message for the coupon error. | |
| createdDate | integer | Displays as the date the specified invoice item was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| createdUser | string | Displays as username of the user who created specified invoice item. | |
| depositAmount | integer | Displays the monetary amount of any deposit paid for the invoice to which the specified invoice item belongs. | |
| description | string | Displays string representation of what the specified invoice item is for. Example: "For Dog Training with Titus Bigly on Thursday, Sep 13, 2018 at 8:00 AM EDT". | |
| discountAmount | integer | Displays as monetary value of any discount applied to the specified invoice item. | |
| discountPercentage | integer | Displays as percentage of any discount applied to the specified invoice item. | |
| giftCardUUId | integer | Provides unique numeric ID for any giftcard used to create the specified invoice item. | |
| grossAmount | integer | Displays as monetary value of payment/refund being applied before accounting for any discounts. Refunds show as negative numbers. | |
| invoiceId | integer | Yes | Provides unique numeric ID for the invoice to which the specified invoice item belongs. |
| invoiceItemId | integer | Yes, on PUT calls | Provides unique numeric ID for the specified invoice item. |
| modifiedUser | string | Displays as username of the user who created the specified invoice item. | |
| netAmount | integer | Displays as monetary value of payment/refund being applied after accounting for any discounts. Refunds show as negative numbers. | |
| packageSoldId | integer | Provides unique numeric ID of any package sold as part of the specified invoice item. | |
| productId | integer | Provides unique numeric ID of any product that is part of the specified invoice item. | |
| quantity | integer | Yes | Displays as number of payments/refunds being applied. |
| rate | integer | Yes | Displays as monetary value of each individual payment/refund being applied. Refunds show as negative numbers. |
| reasonId | integer | Provides unique numeric ID of the reason related to the specified invoice item. | |
| recurringAppointmentId | integer | Provides unique numeric ID of any recurring appointment related to the specified invoice item. | |
| taxable | boolean | Indicates whether or not the specified invoice item is taxable, which would impact the overall balance of the invoice itself. |