Client Invoices — Hubstaff API — Hubstaff Developer Portal

List organization client invoices

GET/v2/organizations/{organization_id}/client_invoices

Returns invoices sent to clients for the given organization.

Results can be filtered by client_ids[], issue_date[start]/[stop], and status. Use include_line_items=true to include invoice line items.

Parameters

Name	In	Type	Description
organization_idrequired	path	integer (int32)
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size
client_ids	query	array integer[]	List of client IDs
issue_date[start]	query	string (date)	Start date (ISO 8601)
issue_date[stop]	query	string (date)	Stop date (ISO 8601)
status	query	string	Invoice status Possible values`draftopenclosed`
include_line_items	query	boolean	Include invoice line items
include	query	array string[]	Specify related data to side load. Possible values`usersclientsprojectstasks`

Responses

200A list of client invoices

object

client_invoicesarray
array<object>
items
object
ClientInvoice model
- organization_idinteger required
  Organization ID
- statusstring required
  Invoice status
- author_idinteger required
  The user who created the invoice
- numberstring required
  Invoice number
- po_numberstring required
  Invoice PO number
- notesstring required
  Invoice notes
- currencystring required
  Invoice currency
- grand_totalnumber required
  Grand total
- paid_amountnumber required
  Amount paid
- tax_1number
  Tax 1 percentage to apply to sub total for enabled line items
- tax_2number
  Tax 2 percentage to apply to sub total for enabled line items
- discountnumber
  Discount percentage to apply to before taxes for enabled line items
- issue_datestring required
  Invoice issue date
- due_datestring
  Invoice due date
- created_atstring required
  When the record was created
- updated_atstring required
  When the record was last updated
- line_itemsarray
  List of invoice line items
  array<object>
  List of invoice line items
  items
  object
  idinteger required
  Invoice item id
  created_atstring required
  When the record was created
  updated_atstring required
  When the record was last updated
  descriptionstring required
  Item description
  quantitynumber required
  Item quantity
  unit_pricenumber required
  Item price
  generatedboolean
  True if this line item was generated
  generated_dataobject
  object
  durationinteger
  Time worked in seconds for generated data
  ratesarray
  Hourly rates used for generated data
  array<number>
  Hourly rates used for generated data
  items
  number(float)
  groupingstring
  The grouping mode used for the generated data
  user_idsarray
  User ids included in generated data
  array<integer>
  User ids included in generated data
  items
  integer(int64)
  project_idsarray
  Project ids included in generated data
  array<integer>
  Project ids included in generated data
  items
  integer(int64)
  task_idsarray
  Tasks ids included in generated data (Client invoices only)
  array<integer>
  Tasks ids included in generated data (Client invoices only)
  items
  integer(int64)
  start_datestring
  The start date for the time include in the generated data
  stop_datestring
  The stop date for the time include in the generated data
  tax_1boolean required
  Item tax 1
  tax_2boolean required
  Item tax 2
  discountboolean required
  Item discount
- viewer_urlstring required
  View only URL
- idinteger required
  Client invoice ID
- client_idinteger required
  Client ID this invoice is for

Example response

json

{
  "client_invoices": [
    {
      "organization_id": 0,
      "status": "string",
      "author_id": 0,
      "number": "string",
      "po_number": "string",
      "notes": "string",
      "currency": "string",
      "grand_total": 0,
      "paid_amount": 0,
      "tax_1": 0,
      "tax_2": 0,
      "discount": 0,
      "issue_date": "2024-01-15",
      "due_date": "2024-01-15",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "line_items": [
        {
          "id": 0,
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-15T10:30:00Z",
          "description": "string",
          "quantity": 0,
          "unit_price": 0,
          "generated": false,
          "generated_data": {
            "duration": 0,
            "rates": [
              0
            ],
            "grouping": "string",
            "user_ids": [
              0
            ],
            "project_ids": [
              0
            ],
            "task_ids": [
              0
            ],
            "start_date": "2024-01-15",
            "stop_date": "2024-01-15"
          },
          "tax_1": false,
          "tax_2": false,
          "discount": false
        }
      ],
      "viewer_url": "https://example.com/resource",
      "id": 0,
      "client_id": 0
    }
  ]
}

400Invalid parameters

object

Hubstaff_Public_V2_Entities_Error model

codestring required
Legacy string error code for backward compatibility
error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
errorstring required
Human-readable error message
detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

401Unauthorized

object

Hubstaff_Public_V2_Entities_Error model

codestring required
Legacy string error code for backward compatibility
error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
errorstring required
Human-readable error message
detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

403API access is only for organizations on an active plan

object

Hubstaff_Public_V2_Entities_Error model

codestring required
Legacy string error code for backward compatibility
error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
errorstring required
Human-readable error message
detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

404Could not find record

object

Hubstaff_Public_V2_Entities_Error model

codestring required
Legacy string error code for backward compatibility
error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
errorstring required
Human-readable error message
detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

429Rate limit exceeded

object

Hubstaff_Public_V2_Entities_Error model

codestring required
Legacy string error code for backward compatibility
error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
errorstring required
Human-readable error message
detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}