id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creationTime
required |
string (date-time)
|
The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
creatorId
required |
string (uuid)
|
The ID of the user who created this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModificationTime
required |
string (date-time)
|
The date and time when this entity was last modified.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastModifierId
required |
string (uuid)
|
The ID of the user who last modified this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isDeleted
required |
boolean
|
Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deleterId
required |
string (uuid)
|
The ID of the user who deleted this entity, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
deletionTime
required |
string (date-time)
|
The date and time when this entity was deleted, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
billerId
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
billerType
required |
InvoicePartyType
InvoicePartyType |
Identifies the type of entity acting as the biller or recipient on an invoice.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
GatewayOwner |
Platform-level gateway owner. | Reseller |
Reseller entity. | Merchant |
Merchant entity. | Customer |
End customer. |
|
name
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
description
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
status
required |
RecurringInvoiceScheduleStatus
RecurringInvoiceScheduleStatus |
Lifecycle status of a recurring invoice schedule (series).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Active |
The series is active and generates invoices on each due run. | Paused |
Generation is suspended; the series can be resumed later. No invoices are generated while paused. | Cancelled |
The series has been cancelled. Terminal: no further generation. | Completed |
The series reached its end (end date or max occurrences). Terminal: no further generation. |
|
schedule
required |
ContractSchedule
ContractSchedule |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ContractSchedule:
| Field |
Type |
Description |
|---|
frequency
required |
Frequency
Frequency |
The type of the recurrence rule.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Secondly |
| Minutely |
| Hourly |
| Daily |
| Weekly |
| Monthly |
| Yearly |
|
| count
required |
integer (int32)
|
The number of occurrences in a particular recurrence.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| until
required |
string (date-time)
|
The datetime that bounds the current recurrence.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| interval
required |
integer (int32)
|
The recurrence interval.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| bySecond
required |
array of integer (int32)
array of |
BySecond rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| byMinute
required |
array of integer (int32)
array of |
BySecond rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| byHour
required |
array of integer (int32)
array of |
BySecond rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| byDay
required |
array of ContractScheduleByDayRule
array of ContractScheduleByDayRule |
Week day rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| byMonth
required |
array of integer (int32)
array of |
Month day rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| byMonthDay
required |
array of integer (int32)
array of |
Month days rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| byYearDay
required |
array of integer (int32)
array of |
Year days rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| byWeekNumber
required |
array of integer (int32)
array of |
Week number rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| bySetPosition
required |
array of integer (int32)
array of |
BySetPosition rule modifier.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| firstDayOfWeek
required |
DayOfWeek
DayOfWeek |
The first day of week, used in calculating weekday-based recurrences
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Sunday |
| Monday |
| Tuesday |
| Wednesday |
| Thursday |
| Friday |
| Saturday |
|
| nextScheduledRun
required |
string (date-time)
|
The next computed billing date, updated after each billing run. Null for contracts that
have never been scheduled or have ended.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| startDate
required |
string (date-time)
|
The earliest date on which this contract is eligible to bill. Set by the user
when creating the contract (defaults to the creation date) and may be set to a
future date to delay first billing. The recurrence engine anchors expansion to
this date and the daily billing job will not fire a contract whose
`startDate` is in the future.
Null on contracts created before this field existed. When it is null, the server
anchors the schedule on the contract's creation time, or on the current time when
that is also absent; callers that compute a schedule themselves should apply the
same fallback.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
nextRunUtc
required |
string (date-time)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
lastRunUtc
required |
string (date-time)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
occurrenceCount
required |
integer (int32)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
endAfterOccurrences
required |
integer (int32)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
autoSend
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
paymentLinkExpiryHours
required |
integer (int32)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
viewTokenExpiryDays
required |
integer (int32)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
customMessage
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
recipientId
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
recipientType
required |
InvoicePartyType
InvoicePartyType |
Identifies the type of entity acting as the biller or recipient on an invoice.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
GatewayOwner |
Platform-level gateway owner. | Reseller |
Reseller entity. | Merchant |
Merchant entity. | Customer |
End customer. |
|
currency
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
paymentTermsValue
required |
PaymentTerms
PaymentTerms |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
DueOnReceipt |
Payment due immediately upon receipt. | Net15 |
Payment due within 15 days of issue. | Net30 |
Payment due within 30 days of issue. | Net45 |
Payment due within 45 days of issue. | Net60 |
Payment due within 60 days of issue. | Net90 |
Payment due within 90 days of issue. | Custom |
Custom number of days specified via InvoiceConsts. |
|
customPaymentDays
required |
integer (int32)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
allowPartialPayment
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
minimumPaymentAmount
required |
number (double)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
partialPaymentTolerance
required |
number (double)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
allowedPaymentMethods
required |
array of string
array of |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
vaultRestriction
required |
VaultRestriction
VaultRestriction |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Any |
Allow any payment method (new or saved). | AllowNewAndSaved |
Allow both new and saved payment methods. | SavedOnly |
Only allow previously saved (vaulted) payment methods. |
|
hppPageId
required |
string (uuid)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
templateId
required |
string (uuid)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
invoiceLevelDiscount
required |
InvoiceDiscountDto
InvoiceDiscountDto |
DTO for an invoice-level discount.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of InvoiceDiscountDto:
| Field |
Type |
Description |
|---|
type
required |
DiscountType
DiscountType |
The type of discount applied to a line item or invoice.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Percent |
Percentage discount (e.g., 10%). | Flat |
Flat dollar amount discount (e.g., $5.00). |
| value
required |
number (double)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| description
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
reminderConfig
required |
InvoiceReminderConfigDto
InvoiceReminderConfigDto |
DTO for invoice reminder configuration. Each member overrides the tenant's reminder default on its
own; a member that is null or omitted inherits that default.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of InvoiceReminderConfigDto:
| Field |
Type |
Description |
|---|
preDueDays
required |
array of integer (int32)
array of |
Days before the due date to send a reminder (for example 7, 3, 1). Null or omitted inherits the
tenant default; an empty list sends no pre-due reminders for this invoice.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| dueDayReminder
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| postDueDays
required |
array of integer (int32)
array of |
Days after the due date to send a reminder (for example 1, 7, 14, 30). Null or omitted inherits
the tenant default; an empty list sends no scheduled post-due reminders for this invoice.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| postDueRecurringDays
required |
integer (int32)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| stopOnPaid
required |
boolean
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| maxReminders
required |
integer (int32)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| dunningEndAction
required |
DunningEndAction
DunningEndAction |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
None |
No automatic action taken. | MarkUncollectible |
Transition the invoice to Uncollectible. | Close |
Transition the invoice to Closed. |
| daysUntilUncollectible
required |
integer (int32)
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
billerSnapshot
required |
InvoicePartySnapshotDto
InvoicePartySnapshotDto |
Read DTO for denormalized biller/recipient info frozen at invoice issuance.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of InvoicePartySnapshotDto:
| Field |
Type |
Description |
|---|
name
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| email
required |
string
|
nullablemax length 256
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| phone
required |
string
|
nullablemax length 30
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| addressLine1
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| addressLine2
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| city
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| state
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| postalCode
required |
string
|
nullablemax length 20
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| country
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| companyName
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxId
required |
string
|
nullablemax length 50
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| logoUrl
required |
string
|
nullablemax length 2048
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
recipientSnapshot
required |
InvoicePartySnapshotDto
InvoicePartySnapshotDto |
Read DTO for denormalized biller/recipient info frozen at invoice issuance.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of InvoicePartySnapshotDto:
| Field |
Type |
Description |
|---|
name
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| email
required |
string
|
nullablemax length 256
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| phone
required |
string
|
nullablemax length 30
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| addressLine1
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| addressLine2
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| city
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| state
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| postalCode
required |
string
|
nullablemax length 20
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| country
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| companyName
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxId
required |
string
|
nullablemax length 50
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| logoUrl
required |
string
|
nullablemax length 2048
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
lineItems
required |
array of InvoiceLineItemDto
array of InvoiceLineItemDto |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of each InvoiceLineItemDto:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Stable identity for update/delete operations.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| sortOrder
required |
integer (int32)
|
Display order on the invoice.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| parentLineItemId
required |
string (uuid)
|
Parent line item ID for bundle/discount/tax line hierarchies.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| name
required |
string
|
Product name snapshot (formal product name).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| description
required |
string
|
Line item description shown on PDF and HPP.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| notes
required |
string
|
Per-line notes visible to the biller only.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| productId
required |
string (uuid)
|
Optional link to the product catalog.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| productCode
required |
string
|
SKU or product code.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| unitOfMeasure
required |
string
|
Unit of measure (e.g., "each", "hour", "GB").
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| commodityCode
required |
string
|
Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most
25 characters.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| quantity
required |
number (double)
|
Quantity.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| unitPrice
required |
number (double)
|
Unit price.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| grossAmount
required |
number (double)
|
Computed: Quantity * UnitPrice.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| cost
required |
number (double)
|
Cost for margin tracking.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| pricingSource
required |
PricingSource
PricingSource |
How the unit price was determined.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Catalog |
Price taken from the product catalog at time of invoicing. | Override |
Price manually overridden by the user. | Promotion |
Price determined by a promotion or coupon. | Contract |
Price from a negotiated contract or quote. |
| discountType
required |
DiscountType
DiscountType |
Type of discount applied to this line item.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Percent |
Percentage discount (e.g., 10%). | Flat |
Flat dollar amount discount (e.g., $5.00). |
| discountValue
required |
number (double)
|
Discount value (percentage or flat amount).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| discountAmount
required |
number (double)
|
Resolved discount amount.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| netAmount
required |
number (double)
|
After discount, before tax.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxRateId
required |
string (uuid)
|
Reference to a reusable tax rate definition.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxRatePercent
required |
number (double)
|
Snapshot of the tax rate percentage.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxableAmount
required |
number (double)
|
Explicit taxable base amount.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxAmount
required |
number (double)
|
Computed tax amount.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxJurisdiction
required |
string
|
Tax jurisdiction (state/country).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxRateSource
required |
InvoiceTaxRateSource
InvoiceTaxRateSource |
Where `taxRatePercent` came from. Always populated on read: a line stored before
provenance existed reads as Catalog when it names a `taxRateId`, otherwise Manual.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Manual |
The operator typed the percentage, or nothing recorded where it came from. | Catalog |
The percentage was snapshotted from one of the biller's named tax rates. | Provider |
The percentage was sourced from the merchant's bound tax provider. |
| taxRateProviderName
required |
string
|
The tax provider that sourced the percentage, when `taxRateSource` is Provider.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| taxCode
required |
string
|
Tax code snapshotted from product or overridden.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isTaxable
required |
boolean
|
Whether tax applies to this line.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| lineTotal
required |
number (double)
|
Line total including tax.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isDiscountLine
required |
boolean
|
Indicates this is a discount adjustment line.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isSystemGenerated
required |
boolean
|
Indicates this line was auto-generated.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isOptional
required |
boolean
|
For quotes-to-invoices flow: whether this line is optional.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| revenueAccount
required |
string
|
GL account for revenue recognition.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| recognitionStartDate
required |
string (date-time)
|
Revenue recognition start date.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| recognitionEndDate
required |
string (date-time)
|
Revenue recognition end date.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| attributes
required |
object
|
Extensibility metadata (key-value pairs).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
customFields
required |
array of CustomFieldValueDto
array of CustomFieldValueDto |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of each CustomFieldValueDto:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| key
required |
string
|
nullablemax length 100
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| label
required |
string
|
nullablemax length 200
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| value
required |
string
|
nullablemax length 2000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
notes
required |
array of EntityNote
array of EntityNote |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of each EntityNote:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| enteredBy
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| timestamp
required |
string (date-time)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| enteredByName
required |
string
|
Denormalized display name of the user who created the note.
Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| content
required |
string
|
nullablemin length 0max length 1000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
recipientNote
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
footerText
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
concurrencyStamp
required |
string
|
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|