Update invoice template line item

PUT

Update invoice template line item

Path parameters

invoiceTemplateIdstringRequired

Invoice Template ID

lineItemIdstringRequired

Invoice Line Item ID

Request

This endpoint expects an object.
namestringOptional
descriptionstringOptional
categorystringOptional

Category of the line item.

serviceStartDatedatetimeOptional
serviceEndDatedatetimeOptional
metadatamap from strings to stringsOptional
glAccountIdstringOptional

ID of general ledger account associated with this line item.

Response

This endpoint returns an object.
approvalPolicylist of objects
approverslist of objects
createdAtdatetime
hasDocumentsboolean

True if the invoice has documents attached.

hasSourceEmailboolean

True if the invoice was created by an incoming email.

idstring
metadatamap from strings to strings

Metadata associated with this invoice.

paymentDestinationConfirmedboolean

True if the payment destination has been confirmed by the vendor. False if the payment destination has been set (for example, a check to an address) but has not been confirmed by the vendor.

statusenum
updatedAtdatetime
amountdoubleOptional

Total amount of invoice in major units

batchPaymentbooleanOptional

If true, this invoice will be paid as a batch payment. Batches are automatically determined by Mercoa based on the payment source, destination, and scheduled payment date.

commentslist of objectsOptional
creatorEntityIdstringOptional

The ID of the entity who created this invoice.

creatorUserobjectOptional

Entity user who created this invoice.

currencyenumOptional

Currency code for the amount. Defaults to USD.

deductionDatedatetimeOptional

Initial date when funds are scheduled to be deducted from payer’s account. The actual deduction date may differ from this date, and will be reflected in the processedAt field.

dueDatedatetimeOptional

Due date of invoice.

feesobjectOptional

Fees associated with this invoice.

invoiceDatedatetimeOptional

Date the invoice was issued.

invoiceNumberstringOptional
lineItemslist of objectsOptional
nextDeductionDatedatetimeOptional

For invoice templates, this is the date when the next recurring payment will be scheduled.

noteToSelfstringOptional
payerobjectOptional
payerIdstringOptional
paymentDestinationobjectOptional
paymentDestinationIdstringOptional
paymentDestinationOptionsobjectOptional
paymentScheduleobjectOptional

If this is a recurring invoice, this will be the payment schedule for the invoice. If not provided, this will be a one-time invoice.

paymentSourceobjectOptional
paymentSourceIdstringOptional
serviceEndDatedatetimeOptional
serviceStartDatedatetimeOptional
shippingAmountdoubleOptional

Shipping amount for this invoice.

taxAmountdoubleOptional

Tax amount for this invoice.

vendorobjectOptional
vendorIdstringOptional