Create invoice
Creates a new sales invoice
Authorizations
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Headers
Body
ID of the company entity
Unique invoice number. If not provided, one will be generated automatically when the invoice is opened.
Invoice description
"USD"
Payment type for the invoice
BANK_TRANSFER- Payment via bank transfer. Bank information will be displayed on the invoiceSTRIPE- Payment via Stripe. A payment link will be sent to the customer
⚠️ This enum is not exhaustive; new values may be added in the future.
BANK_TRANSFER, STRIPE ID of the bank account where money should be sent to
Date the invoice was issued
Date the invoice payment is due
ID of the customer
ID of the invoice template
Number of days from the invoice date to when the invoice is due. Setting this will automatically calculate the due date
Purchase order number
Text that will be added to the additional text section of the invoice template
Whether the invoice line amounts are inclusive of tax. True means tax is included in the line amount, false means tax will be added on top
Custom foreign exchange rate for the ledger's local currency. If not provided, Light uses official ECB rates
Custom foreign exchange rate for the ledger's group currency. If not provided, Light uses official ECB rates
List of invoice line items to create
List of custom properties to set on the invoice or line
List of custom properties to set on the vendor. Replaces the existing set.
Response
default response
Unique identifier for the object
ID of the company
ID of the contract, if this is invoice is linked to a contract
ID of the entity
Total invoice amount in cents, with discounts and tax applied
Payment type for the invoice
BANK_TRANSFER- Payment via bank transfer. Bank information will be displayed on the invoiceSTRIPE- Payment via Stripe. A payment link will be sent to the customer
⚠️ This enum is not exhaustive; new values may be added in the future.
BANK_TRANSFER, STRIPE ID of the bank account where money should be sent to
Date the invoice was issued
Date the invoice payment is due
Number of days from the invoice date to when the invoice is due. Updating this field will automatically set the invoice due date
ID of the customer
ID of the invoice template
Text that will added to the additional text section of the invoice template
Invoice number. This number is guaranteed to be unique and sequential per entity. By default Light will generate this number when the invoice is opened, but you can provide your own custom number when creating or updating a draft invoice
The invoice state
DRAFT- The invoice is in draft and can be modified. Next valid states are OPEN_IN_PROGRESS or ARCHIVEDOPEN_IN_PROGRESS- The invoice is being opened. Next valid state is OPEN or DRAFTOPEN- The invoice is open. Next valid states are PAYMENT_PENDING, PARTIALLY_PAID, PAID or ARCHIVEDPAYMENT_PENDING- The payment was initiated by Light and is waiting to be collected. Next valid state is PAIDPARTIALLY_PAID- The invoice is partially paid. Next valid state is PAIDPAID- The invoice is fully paidARCHIVED- The invoice is archived and cannot be modified
⚠️ This enum is not exhaustive; new values may be added in the future.
DRAFT, OPEN_IN_PROGRESS, OPEN, PAYMENT_PENDING, PARTIALLY_PAID, PAID, ARCHIVED Timestamp when the invoice was opened
Purchase order number
Description of the invoice
"USD"
Name of the tax engine to be used
AVATAX- Avalara AvaTax will be used for tax calculationsLIGHT- Light built-in tax engine will be used for tax calculationsSPHERE- Sphere tax engine will be used for tax calculations
⚠️ This enum is not exhaustive; new values may be added in the future.
AVATAX, LIGHT, SPHERE Whether the invoice line amount is inclusive of tax or not. True means tax is already included in the line amount and will not be added on top, false means tax will be added on top of the line amount
Custom foreign exchange rate for the ledger's local currency. If not provided Light uses official ECB rates
Custom foreign exchange rate for the ledger's group currency. If not provided Light uses official ECB rates
List of invoice line items. This is only returned when fetching a single invoice by id
List of custom properties associated with the invoice
Custom properties set on the vendor.
Timestamp when the invoice was created
Timestamp when the invoice was last updated
ID of the user who last updated the invoice
Failure context when vendor onboarding fails.