Create Invoice Line Item

POST /invoices/{id}/line-items

Request

{
  "description": "Platform subscription",
  "quantity": "1",
  "unitPrice": "500"
}

Response

{
  "id": "oQLSmmnn",
  "accountId": "aBsZxlLh",
  "status": "upcoming",
  "dueDate": "2024-02-23T00:00:00Z",
  "issueDate": "2024-01-24T16:37:44.958601Z",
  "billingPeriodStart": "2024-01-01T00:00:00Z",
  "billingPeriodEnd": "2024-01-31T23:59:59Z",
  "billingPeriod": "Jan 1, 2024 - Jan 31, 2024",
  "currency": "USD",
  "description": "Invoice for period January 1, 2024 to January 31, 2024",
  "lineItems": [
    {
      "id": "tlfAFLJI",
      "description": "Platform subscription",
      "billingPeriodStart": "2024-01-01T00:00:00Z",
      "billingPeriodEnd": "2024-01-31T23:59:59Z",
      "quantity": "1",
      "unitPrice": "200",
      "totalPrice": "200",
      "isEditable": false,
      "productId": "HyujZkkm"
    },
    {
      "id": "vPcZvThU",
      "description": "Monthly user seats",
      "billingPeriodStart": "2024-01-01T00:00:00Z",
      "billingPeriodEnd": "2024-01-31T23:59:59Z",
      "quantity": "1",
      "unitPrice": "500",
      "totalPrice": "500",
      "isEditable": false,
      "productId": "GPAPMbiw"
    }
  ],
  "subtotal": "700",
  "tax": "0",
  "total": "700",
  "amountPaid": "0",
  "amountRemaining": "700",
  "externalId": "80c84e7d-b265-4835-8ea0-e38a6c924ba4",
  "externalProvider": "xero",
  "externalUrl": "https://go.xero.com/",
  "purchaseOrderNumber": null,
  "createdAt": "2024-01-24T16:36:52.703596Z",
  "updatedAt": "2024-01-26T19:00:40.957736Z"
}

Creates a line item for the given invoice.

Params

id · string

The ID of the invoice to create a line item for.

Request

Request

{
  "description": "Platform subscription",
  "quantity": "1",
  "unitPrice": "500"
}

description · string · required

The description of the line item.

quantity · decimal · required

The quantity of the line item as a decimal string.

unitPrice · decimal · required

The unit price for the given line item as a decimal string.

Response

Response

{
  "id": "oQLSmmnn",
  "accountId": "aBsZxlLh",
  "status": "upcoming",
  "dueDate": "2024-02-23T00:00:00Z",
  "issueDate": "2024-01-24T16:37:44.958601Z",
  "billingPeriodStart": "2024-01-01T00:00:00Z",
  "billingPeriodEnd": "2024-01-31T23:59:59Z",
  "billingPeriod": "Jan 1, 2024 - Jan 31, 2024",
  "currency": "USD",
  "description": "Invoice for period January 1, 2024 to January 31, 2024",
  "lineItems": [
    {
      "id": "tlfAFLJI",
      "description": "Platform subscription",
      "billingPeriodStart": "2024-01-01T00:00:00Z",
      "billingPeriodEnd": "2024-01-31T23:59:59Z",
      "quantity": "1",
      "unitPrice": "200",
      "totalPrice": "200",
      "isEditable": false,
      "productId": "HyujZkkm"
    },
    {
      "id": "vPcZvThU",
      "description": "Monthly user seats",
      "billingPeriodStart": "2024-01-01T00:00:00Z",
      "billingPeriodEnd": "2024-01-31T23:59:59Z",
      "quantity": "1",
      "unitPrice": "500",
      "totalPrice": "500",
      "isEditable": false,
      "productId": "GPAPMbiw"
    }
  ],
  "subtotal": "700",
  "tax": "0",
  "total": "700",
  "amountPaid": "0",
  "amountRemaining": "700",
  "externalId": "80c84e7d-b265-4835-8ea0-e38a6c924ba4",
  "externalProvider": "xero",
  "externalUrl": "https://go.xero.com/",
  "purchaseOrderNumber": null,
  "createdAt": "2024-01-24T16:36:52.703596Z",
  "updatedAt": "2024-01-26T19:00:40.957736Z"
}