UpdateSalesInvoiceRequestBody.md

UpdateSalesInvoiceRequestBody

Fields

Field	Type	Required	Description	Example
testmode	Optional<Boolean>	➖	Whether the entity was created in test mode or live mode. This field does not update the mode of the entity. Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.	false
status	Optional<SalesInvoiceStatus>	➖	The status for the invoice to end up in. A draft invoice is not paid or not sent and can be updated after creation. Setting it to issued sends it to the recipient so they may then pay through our payment system. To skip our payment process, set this to paid to mark it as paid. It can then subsequently be sent as well, same as with issued. A status value that cannot be set but can be returned is canceled, for invoices which were issued, but then canceled. Currently this can only be done for invoices created in the dashboard. Dependent parameters: - paymentDetails is required if invoice should be set directly to paid - customerId and mandateId are required if a recurring payment should be used to set the invoice to paid - emailDetails optional for issued and paid to send the invoice by email	draft
memo	JsonNullable<String>	➖	A free-form memo you can set on the invoice, and will be shown on the invoice PDF.	An updated memo!
paymentTerm	JsonNullable<SalesInvoicePaymentTerm>	➖	The payment term to be set on the invoice.	30 days
paymentDetails	Optional<SalesInvoicePaymentDetails>	➖	N/A
emailDetails	JsonNullable<SalesInvoiceEmailDetails>	➖	N/A
recipientIdentifier	Optional<String>	➖	An identifier tied to the recipient data. This should be a unique value based on data your system contains, so that both you and us know who we're referring to. It is a value you provide to us so that recipient management is not required to send a first invoice to a recipient.	customer-xyz-0123
recipient	JsonNullable<SalesInvoiceRecipient>	➖	N/A
lines	List<SalesInvoiceLineItem>	➖	Provide the line items for the invoice. Each line contains details such as a description of the item ordered and its price. All lines must have the same currency as the invoice.
discount	JsonNullable<SalesInvoiceDiscount>	➖	N/A
isEInvoice	Optional<Boolean>	➖	This indicates whether the invoice is an e-invoice. The default value is false and can't be changed after the invoice has been issued. When emailDetails is provided, an additional email is sent to the recipient.	false