Invoice

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enumeration memberCurrency type inherited from work zone upon WO creation. References vlangLangLookup.ID; also matches enumeration CurrencyType. Modifications for existing records are not allowed.
TimeSetIdIntegerGets a time period ID
Period{TimePeriod entity reference}TimePeriod object defined by TimeSetId
Group{BillingAccount entity reference}Gets a billing account object
BillingContact{Contact entity reference}Billing Contact associated with the Billing Account
NumberStringGets a invoice number; initially empty, generated by Post action
StateCiInvoiceState enumeration memberGets a invoice state; supported values are draft, posted, paid, paid in full, credit, credit used.
PoNumberStringGets an optional field used for customer reference
DtDueDateTime or NULLGets an invoice due date computed when invoice is posted; initially empty
GlAccountStringGets a GL account number
CommentsStringGets a comments
AmtBase{MoneyValue entity reference}Gets an invoice subtotal before tax
AmtTax{MoneyValue entity reference}Gets an invoice total tax amount
AmtTotal{MoneyValue entity reference}Gets an invoice total amount (base + tax)
IsMultilineBooleanGets a value indicating whether this invoice consists of more than one line item
TaxTransactionIdStringGets a tax transaction ID (non-empty value means tax was computed)
IsTaxDirtyBooleanGets a value indicating whether invoice content was changed since tax was computed.
LineItems[{InvoiceLine entity reference}, ...]Gets a line items collection.
ExtNumberStringGets or sets an external number
DtPostedDateTime or NULLDate of "posted" action; a.k.a. Invoice Date
IsManuallySentBooleanTrue means Customer Invoice was sent manually to the client (i.e. as e-mail, rather than electronically through Corrigo platform). This flag is available for posted Customer Invoices.
DraftProcessStepIdDraftProcessStep enumeration memberSub-status value, used when Customer Invoice status is Draft. Indicates either desired action (such as "Customer Invoice is ready to Post") or result of the action (such as "Post operation failed").
CanExpediteBooleanOption for the SPs to request Expedite flag on their invoices
CanEarlyPaymentBooleanOption for the SPs to request Early payment flag on their invoices
IsAvailableExpeditedInvoiceFlagsBooleanRead only settings for Invoice Flags
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
Properties[{PropertyTreeNode object reference}, ...]List of filled properties
LimitMultipleEntitiesNumberBehaviourBooleanReturn exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API