invoice-template > line-item

Update invoice template line item

Update invoice template line item

put/invoice-template/{invoiceTemplateId}/line-item/{lineItemId}

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/invoice-template/{invoiceTemplateId}/line-item/{lineItemId}
  • Auth: HTTP bearer

Path parameters

invoiceTemplateIdstring required

Invoice Template ID

lineItemIdstring required

Invoice Line Item ID

Request body

namestring
descriptionstring
categorystring

Category of the line item.

serviceStartDatestring date-time
serviceEndDatestring date-time
metadataobject
glAccountIdstring

ID of general ledger account associated with this line item.

Response

Response with status 200

status'UNASSIGNED' | 'DRAFT' | 'NEW' | 'APPROVED' | 'SCHEDULED' | 'PENDING' | 'PAID' | 'ARCHIVED' | 'REFUSED' | 'CANCELED' | 'FAILED' required
amountnumber double

Total amount of invoice in major units

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
invoiceDatestring date-time

Date the invoice was issued.

deductionDatestring date-time

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.

nextDeductionDatestring date-time

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

dueDatestring date-time

Due date of invoice.

invoiceNumberstring
noteToSelfstring
serviceStartDatestring date-time
serviceEndDatestring date-time
netTermsinteger

Net terms in days. Must be a positive number.

payerIdstring
paymentSourceIdstring
vendorIdstring
paymentDestinationIdstring
paymentDestinationConfirmedboolean required

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.

batchPaymentboolean

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.

hasDocumentsboolean required

True if the invoice has documents attached.

hasSourceEmailboolean required

True if the invoice was created by an incoming email.

taxAmountnumber double

Tax amount for this invoice.

shippingAmountnumber double

Shipping amount for this invoice.

metadataobject required

Metadata associated with this invoice.

creatorEntityIdstring
entityGroupIdstring
entityGroupForeignIdstring

The foreign ID of the entity group that created this invoice.

createdAtstring date-time required
updatedAtstring date-time required
ocrJobIdstring
recurringTemplateIdstring
idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.