New Introducing the Light partner portalPartner portal Join the movement

API/Reference/Invoice Payables

Replace invoice payable specification rows

PUT 
https://api.light.inc/v1/invoice-payables/{invoicePayableId}/specification-rows

Replaces every specification row of a self-billed invoice payable that is still a draft. The rows print on the second page of its PDF, in the order sent, and never post. Send an empty list to remove them all.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Path parameters

  • invoicePayableId string · uuidrequired

Request body

application/json;charset=UTF-8

  • rows array of object

    Specification rows in print order. Replaces every row the bill had. At most 500.

    • section string

      Heading of the group the row prints under, such as Gross revenue per market. Rows with the same section in a run print together under one heading.

    • label string

      Text the row prints, such as FCR-D Up

    • code string

      Short code printed next to the label, such as fcr_d_up

    • periodStart string · date

      First day of the period the row covers

    • periodEnd string · date

      Last day of the period the row covers

    • quantity number

      Quantity the row covers

    • quantityUnit string

      Unit of the quantity, such as MWh

    • unitPrice number

      Price per unit of the quantity

    • volume number

      A second measure printed in its own column, such as capacity in MW

    • volumeUnit string

      Unit of the volume, such as MW

    • amount integer · int64

      Amount in the smallest denomination of amountCurrency, when it differs from the bill's currency

    • amountCurrency string

      Currency of amount

    • documentAmount integer · int64

      Amount in the smallest denomination of the bill's currency

    • percentage number

      Percentage the row prints, such as 8 for a share of 8%

    • rowKind string

      DETAIL for an ordinary row, SUBTOTAL or TOTAL for a row printed in bold. Defaults to DETAIL.

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of DETAIL SUBTOTAL TOTAL

Response

  • id string · uuid

    Unique identifier of the specification row

  • position integer · int32

    Zero-based position of the row on the specification, in the order the rows were sent

  • section string

    Heading of the group the row prints under, such as Gross revenue per market. Rows with the same section in a run print together under one heading.

  • label string

    Text the row prints, such as FCR-D Up

  • code string

    Short code printed next to the label, such as fcr_d_up

  • periodStart string · date

    First day of the period the row covers

  • periodEnd string · date

    Last day of the period the row covers

  • quantity number

    Quantity the row covers

  • quantityUnit string

    Unit of the quantity, such as MWh

  • unitPrice number

    Price per unit of the quantity

  • volume number

    A second measure printed in its own column, such as capacity in MW

  • volumeUnit string

    Unit of the volume, such as MW

  • amount integer · int64

    Amount in the smallest denomination of amountCurrency, when it differs from the bill's currency

  • amountCurrency string

    Currency of amount

  • documentAmount integer · int64

    Amount in the smallest denomination of the bill's currency

  • documentAmountCurrency string

    Currency of documentAmount. It follows the bill's currency when that changes

  • percentage number

    Percentage the row prints, such as 8 for a share of 8%

  • rowKind string

    DETAIL for an ordinary row, SUBTOTAL or TOTAL for a row printed in bold. Defaults to DETAIL.

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of DETAIL SUBTOTAL TOTAL