activities4

auth6

bank_integrations11

bank_transaction_rules8

bank_transactions9

charts4

claim_license1

client_gateway_tokens7

clients14

companies10

company_gateways8

company_ledger1

company_user1

connected_account1

credits8

Credits1

designs8

documents1

emails1

expense1

expense_categories8

expenses8

export1

group_settings9

health_check1

import1

imports2

invoices12

locations7

logout1

migration3

one_time_token1

payment_terms7

payment_termss1

payments11

ping2

postmark3

preview2

products9

projects9

Purchase Orders11

quotes12

Recurring Invoices11

recurring_expense1

recurring_expenses8

recurring_quotes9

refresh1

reports27

scheduler1

search1

statics1

subscriptions8

support1

system_logs2

tags8

task_schedulers7

task_status8

tasks10

tax_rates7

templates2

tokens8

update2

users11

vendors9

webcron1

webhooks7

Webhooks1

yodlee1

products

Add product document

Changed on Apr 20, 2026

POST /api/v1/products/{id}/upload

Handles the uploading of a document to a product"

post/api/v1/products/{id}/upload

Request

Base URL
https://demo.invoiceninja.com
Auth
none declared. Required headers: X-API-TOKEN, X-Requested-With
TypeScript
https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/products/:id/upload/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring string required

The Product Hashed ID

Query parameters

includestring

Include child relationships of the Client Object. ie ?include=documents,system_logs

Available includes:

contacts [All contacts related to the client]
documents [All documents related to the client]
gateway_tokens [All payment tokens related to the client]
activities [All activities related to the client]
ledger [The client ledger]
system_logs [System logs related to the client]
group_settings [The group settings object the client is assigned to]

Usage:

/api/v1/clients?include=contacts,documents,activities

Headers

X-API-TOKENstring required

Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required

Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Request body multipart/form-data

_methodstring

documentsstring[]

Example request

{
  "_method": "POST"
}

Response

Returns the Product object

idstring

The hashed product ID.

user_idstring

The hashed ID of the user that created this product.

assigned_user_idstring

The hashed ID of the user assigned to this product.

project_idstring

The hashed ID of the project that this product is associated with.

vendor_idstring

The hashed ID of the vendor that this product is associated with.

custom_value1string

Custom value field 1.

custom_value2string

Custom value field 2.

custom_value3string

Custom value field 3.

custom_value4string

Custom value field 4.

product_keystring

The product key.

notesstring

Notes about the product.

costnumber double

The cost of the product. (Your purchase price for this product)

pricenumber double

The price of the product that you are charging.

quantitynumber double

The quantity of the product. (used as a default)

tax_name1string

The name of tax 1.

tax_rate1number double

The rate of tax 1.

tax_name2string

The name of tax 2.

tax_rate2number double

The rate of tax 2.

tax_name3string

The name of tax 3.

tax_rate3number double

The rate of tax 3.

archived_atinteger

The timestamp when the product was archived.

created_atinteger

The timestamp when the product was created.

updated_atinteger

Timestamp

is_deletedboolean

Boolean flag determining if the product has been deleted

in_stock_quantityinteger

The quantity of the product that is currently in stock

stock_notificationboolean

Indicates whether stock notifications are enabled for this product

stock_notification_thresholdinteger

The minimum quantity threshold for which stock notifications will be triggered

max_quantityinteger

The maximum quantity that can be ordered for this product

product_imagestring uri-reference

The URL of the product image

tax_idstring

The tax category id for this product.'

The following constants are available (default = '1')

PRODUCT_TYPE_PHYSICAL = '1'
PRODUCT_TYPE_SERVICE = '2'
PRODUCT_TYPE_DIGITAL = '3'
PRODUCT_TYPE_SHIPPING = '4'
PRODUCT_TYPE_EXEMPT = '5'
PRODUCT_TYPE_REDUCED_TAX = '6'
PRODUCT_TYPE_OVERRIDE_TAX = '7'
PRODUCT_TYPE_ZERO_RATED = '8'
PRODUCT_TYPE_REVERSE_TAX = '9'

income_account_idstring

The accounting income account identifier this product maps to (used by external accounting integrations such as QuickBooks).

Example response

{
  "id": "eP01N",
  "user_id": "n30m4",
  "assigned_user_id": "pR0j3",
  "project_id": "pR0j3",
  "vendor_id": "pR0j3",
  "custom_value1": "Custom value 1",
  "custom_value2": "Custom value 2",
  "custom_value3": "Custom value 3",
  "custom_value4": "Custom value 4",
  "product_key": "1234",
  "notes": "These are some notes about the product.",
  "cost": 10,
  "price": 20,
  "quantity": 5,
  "tax_name1": "Tax 1",
  "tax_rate1": 10,
  "tax_name2": "Tax 2",
  "tax_rate2": 5,
  "tax_name3": "Tax 3",
  "archived_at": 1647604800,
  "created_at": 1647604800,
  "updated_at": 1647691496,
  "tax_id": "1",
  "income_account_id": "42"
}

Changes

Apr 20, 202669a36036d334 Revision changes
- info
  added the optional property to the response with the status
Jun 6, 20248e82a2bd77e0 Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (7 revisions)