Raw schema
{
"type": "object",
"properties": {
"client_id": {
"type": "string",
"minLength": 1,
"description": "The client's hashed id, e.g. \"Wpmbk5ezJn\"."
},
"date": {
"description": "Document date, YYYY-MM-DD.",
"type": "string"
},
"due_date": {
"description": "Due date (valid-until for quotes), YYYY-MM-DD.",
"type": "string"
},
"number": {
"description": "Document number. Omit to let Invoice Ninja assign the next one.",
"type": "string"
},
"po_number": {
"description": "Purchase order number.",
"type": "string"
},
"line_items": {
"description": "Line items. On update this REPLACES all existing lines.",
"type": "array",
"items": {
"type": "object",
"properties": {
"product_key": {
"description": "Product / item name (the product key).",
"type": "string"
},
"notes": {
"description": "Line description.",
"type": "string"
},
"cost": {
"description": "Unit price.",
"type": "number"
},
"quantity": {
"description": "Quantity.",
"type": "number"
},
"discount": {
"description": "Line discount (amount or percent, see is_amount_discount).",
"type": "number"
},
"is_amount_discount": {
"description": "true = discount is an amount; false = a percentage.",
"type": "boolean"
},
"tax_name1": {
"description": "First tax name, e.g. VAT.",
"type": "string"
},
"tax_rate1": {
"description": "First tax rate in percent.",
"type": "number"
},
"tax_name2": {
"description": "Second tax name.",
"type": "string"
},
"tax_rate2": {
"description": "Second tax rate in percent.",
"type": "number"
}
}
}
},
"public_notes": {
"description": "Notes shown to the client.",
"type": "string"
},
"private_notes": {
"description": "Internal notes, not shown to the client.",
"type": "string"
},
"terms": {
"description": "Terms text.",
"type": "string"
},
"footer": {
"description": "Footer text.",
"type": "string"
},
"discount": {
"description": "Document-level discount (amount or percent).",
"type": "number"
},
"is_amount_discount": {
"description": "true = discount is an amount; false = a percentage.",
"type": "boolean"
},
"partial": {
"description": "Deposit / partial amount due first.",
"type": "number"
},
"partial_due_date": {
"description": "Due date of the partial amount, YYYY-MM-DD.",
"type": "string"
},
"project_id": {
"description": "Link to a project (hashed id).",
"type": "string"
},
"tax_name1": {
"description": "Document-level tax name.",
"type": "string"
},
"tax_rate1": {
"description": "Document-level tax rate in percent.",
"type": "number"
}
},
"required": [
"client_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}