PM
PMProforma
The main properties of a pro forma invoice. The records of this type are created during the project billing process and edited through the Pro Forma Invoices (PM307000) form (which corresponds to the ProformaEntry graph).
View API Entity: ProFormaInvoice
/entity/Default/25.200.001/ProFormaInvoice| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
ARInvoiceDocType | nvarchar(3) | AR Doc. Type | - | |
Description:The type of the corresponding accounts receivable document created on release of the pro forma invoice. The field can have one of the values described in ARInvoiceType.ListAttribute. | ||||
ARInvoiceRefNameNonexistent in DB | string | AR Ref. Nbr. | - | |
Description:The reference name to the corresponding accounts receivable document created on release of the pro forma invoice. The value of this field corresponds to the value of the ARInvoiceRefNbr field. | ||||
ARInvoiceRefNbr | nvarchar(15) | AR Ref. Nbr. | ARInvoice | |
Description:The reference number of the corresponding accounts receivable document created on release of the pro forma invoice. The value of this field corresponds to the value of the ARInvoice.RefNbr field. | ||||
ARInvoiceRefStatusNonexistent in DB | string | AR Doc. Status | - | |
Description:The status of the document. The value of the field is determined by the values of the status flags, such as ARDocStatus.Hold, ARDocStatus.Balanced, ARDocStatus.Voided, ARDocStatus.Scheduled. The field can have one of the values described in ARDocStatus.ListAttribute. | ||||
AllocatedRetainedTotal | decimal | - | ||
Description:The allocated retained total (in the base currency). | ||||
AmountDueNonexistent in DB | decimal? | Amount Due Total in Base Currency | - | |
Description:The amount due in the base currency. The difference between the invoice total and retainage total. | ||||
Approved | bit | - | ||
Description:Specifies (if set to true) that the document is approved. | ||||
AvalaraCustomerUsageType | char(1) | Tax Exemption Type | - | |
Description:The customer entity type for reporting purposes. The field is used if the system is integrated with an external tax calculation system and the External Tax Calculation Integration feature is enabled. The field can have one of the values described in TXAvalaraCustomerUsageType.ListAttribute. Defaults to the customer entity type that is specified for the location of the customer. | ||||
BillAddressID | int | - | ||
Description:The identifier of the Billing Address object, associated with the customer. Corresponds to the PMAddress.AddressID field. | ||||
BillContactID | int | Billing Contact | PMContact | |
Description:The identifier of the billing contact associated with the customer. Corresponds to the ARContact.ContactID field. | ||||
BranchBaseCuryIDNonexistent in DB | string | - | ||
Description:No description available | ||||
BranchID | int | Branch | - | |
Description:The identifier of the Branch to which the pro forma invoice belongs. The value of this field corresponds to the value of the Branch.BranchID field. | ||||
Corrected | bit | Corrected | - | |
Description:Specifies (if set to true) that the document has been corrected. | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime | datetime | Created On | - | |
Description:No description available | ||||
CuryAllocatedRetainedTotal | decimal | Allocated Retained Total | - | |
Description:The allocated retained total. | ||||
decimal? | Amount Due | - | ||
Description:The amount due. The difference between the Invoice Total and Retainage Total. | ||||
CuryDocTotal API | decimal | Invoice Total | - | |
Description:The invoice total. The sum of the progress billing total, time and material total, and tax total values. | ||||
CuryID API | nvarchar(5) | Currency | Currency | |
Description:The identifier of the pro forma invoice currency. The value of this field corresponds to the value of the Currency.CuryID field. | ||||
CuryInfoID | bigint | - | ||
Description:The identifier of the CurrencyInfo object associated with the document. Corresponds to the CurrencyInfoID field. | ||||
CuryProgressiveTotal API | decimal | Progress Billing Total | - | |
Description:The total amount to invoice of the progress billing lines of the document. | ||||
CuryRetainageDetailTotal | decimal | Retainage Detail Total | - | |
Description:The total retained amount for the progress billing lines and time and material lines of the pro forma invoice. Calculated as the sum of the values in the retainage amount column for the lines with progressive type plus the sum of the values in the retainage amount column for the lines with transaction type of the pro forma invoice. | ||||
CuryRetainageTaxInclTotal | decimal | Retained Inclusive Tax Total | - | |
Description:The total inclusive retained tax amount in document currency. | ||||
CuryRetainageTaxTotal | decimal | Retained Tax Total | - | |
Description:The total retained tax amount. | ||||
decimal? | Retainage Total | - | ||
Description:The total retained amount. Calculated as the sum of CuryRetainageDetailTotal and CuryRetainageTaxTotal. | ||||
CuryTaxInclTotal | decimal | Inclusive Tax Total | - | |
Description:The total inclusive tax amount of the document in document currency. | ||||
CuryTaxTotal API | decimal | Tax Total | - | |
Description:The total tax amount of the document. | ||||
CuryTaxTotalWithRetainageNonexistent in DB | decimal? | Tax Total | - | |
Description:The tax amount of the document. Calculated as the sum of CuryTaxTotal plus CuryRetainageTaxTotal. | ||||
CuryTransactionalTotal API | decimal | Time and Material Total | - | |
Description:The total amount to invoice of the time and material lines of the document. | ||||
CustomerBaseCuryIDNonexistent in DB | string | - | ||
Description:No description available | ||||
CustomerID API | int | Customer | BAccountR | |
Description:The identifier of the Customer associated with the pro forma invoice. Defaults to the customer associated with the project. The value of this field corresponds to the value of the BAccount.BAccountID field. | ||||
Description API | nvarchar(255) | Description | - | |
Description:The description of the pro forma invoice, which is provided by the billing rule and can be manually modified. | ||||
DiscDate | datetime | Cash Discount Date | - | |
Description:The end date of the cash discount period, which the system calculates by using the credit terms. | ||||
DocTotal | decimal | Invoice Total in Base Currency | - | |
Description:The invoice total in the base currency. | ||||
DueDate | datetime | Due Date | - | |
Description:The date when the payment for the document is due, in accordance with the credit terms. | ||||
EnableProgressive | bit | Enable Progressive Tab | - | |
Description:Specifies (if set to true) that the document has lines of project progress billing type. | ||||
EnableTransactional | bit | Enable Transactions Tab | - | |
Description:Specifies (if set to true) that the document has lines of project time and material billing type. | ||||
ExtRefNbr API | nvarchar(30) | External Ref. Nbr | - | |
Description:The reference number of the external document. | ||||
ExternalTaxExemptionNumber | nvarchar(30) | Tax Exemption Number | - | |
Description:The tax exemption number for reporting purposes. The field is used if the system is integrated with an external tax calculation system and the External Tax Calculation Integration feature is enabled. | ||||
FinPeriodID API | string | Post Period | FinPeriod | |
Description:The financial period that corresponds to the invoice date. | ||||
Hold API | bit | Hold | - | |
Description:Specifies (if set to true) that the document is on hold. | ||||
InvoiceDate API | datetime | Invoice Date | - | |
Description:The date on which the pro forma invoice was created. | ||||
InvoiceNbr | nvarchar(40) | Customer Order Nbr. | - | |
Description:The original reference number or ID assigned by the customer to the customer document. | ||||
IsAIAOutdated | bit | AIA Is Outdated | - | |
Description:Specifies (if set to true) that the current version of the AIA report is not up-to-date and should be reprinted. | ||||
IsMigratedRecord | bit | Migrated | - | |
Description:No description available | ||||
IsTaxValid | bit | Tax Is Up to Date | - | |
Description:Specifies (if set to true) that the amount of tax calculated with the external tax engine (such as Avalara) is up to date. If this field equals false, the document was updated since the last synchronization with the tax Engine and taxes might need recalculation. | ||||
LastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LastModifiedDateTime API | datetime | Last Modified On | - | |
Description:No description available | ||||
LineCntr | int | - | ||
Description:A counter of the document lines, which is used internally to assign numbers to newly created lines. We do not recommend that you rely on this field to determine the exact number of lines because it might not reflect the this number under various conditions. | ||||
LocationID API | int | Location | - | |
Description:The identifier of the Location associated with the pro forma invoice. The value of this field corresponds to the value of the Location.LocationID field. | ||||
NoteID | uniqueidentifier | - | ||
Description:No description available | ||||
NumberOfLinesNonexistent in DB | int? | - | ||
Description:The number of detail lines linked to the pro forma invoice. | ||||
OwnerID | int | Owner | Contact | |
Description:The contact responsible for the document. Corresponds to the Contact.ContactID field. | ||||
ProgressiveTotal | decimal | Progress Billing Total in Base Currency | - | |
Description:The total amount to invoice of the progress billing lines of the document in the base currency. | ||||
ProjectID API | int | Project | PMProject | |
Description:The identifier of the project associated with the pro forma invoice. The value of this field corresponds to the value of the PMProject.contractID field. | ||||
ProjectNbr | nvarchar(15) | Application Nbr. | - | |
Description:The application number. | ||||
RefNbr API | nvarchar(15) | Reference Nbr. | - | |
Description:The reference number of the pro forma invoice. The number is generated from the numbering sequence, which is specified on the Projects Preferences (PM101000) form. | ||||
Rejected | bit | - | ||
Description:Specifies (if set to true) that the document is rejected. | ||||
Released | bit | Released | - | |
Description:Specifies (if set to true) that the document has been released. | ||||
RetainageDetailTotal | decimal | Retainage Detail Total in Base Currency | - | |
Description:The total retained amount for the progress billing lines and time and material lines of the pro forma invoice in the base currency. | ||||
RetainagePct | decimal | Retainage (%) | - | |
Description:The retainage in percents. | ||||
RetainageTaxInclTotal | decimal | Retainage Inclusive Tax in Base Currency | - | |
Description:The total inclusive retained tax amount in base currency. | ||||
RetainageTaxTotal | decimal | Retainage Tax Total in Base Currency | - | |
Description:The total retained tax amount in the base currency. | ||||
RetainageTotalNonexistent in DB | decimal? | Retainage Total in Base Currency | - | |
Description:The total retained amount in the base currency. Calculated as the sum of RetainageDetailTotal and RetainageTaxTotal. | ||||
ReversedARInvoiceDocType | nvarchar(3) | Reversing Doc. Type | - | |
Description:The type of the AR document that reverses the AR document specified in the AR Ref. Nbr. field. The field can have one of the values described in ARInvoiceType.ListAttribute. | ||||
ReversedARInvoiceRefNbr | nvarchar(15) | Reversing Ref. Nbr. | ARInvoice | |
Description:The reference number of the AR document that reverses the AR document specified in the AR Ref. Nbr. field. The value of this field corresponds to the value of the ARInvoice.RefNbr field. | ||||
RevisionID | int | Revision | - | |
Description:The revision number of the pro forma invoice, which is an integer that the system assigns sequentially, starting from 1. | ||||
SelectedNonexistent in DB | bool? | Selected | - | |
Description:No description available | ||||
ShipAddressID | int | - | ||
Description:The identifier of the shipping address associated with the customer. Corresponds to the PMAddress.AddressID field. | ||||
ShipContactID | int | Shipping Contact | PMShippingContact | |
Description:The identifier of the shipping contact associated with the customer. Corresponds to the PMContact.ContactID field. | ||||
Status API | char(1) | Status | - | |
Description:The read-only status of the document. The field can have one of the following values: ""H"": On Hold, ""A"": Pending Approval, ""O"": Open, ""C"": Closed, ""R"": Rejected | ||||
TaxInclTotal | decimal | Inclusive Tax Total in Base Currency | - | |
Description:The total inclusive tax amount of the document in base currency. | ||||
TaxTotal | decimal | Tax Total in Base Currency | - | |
Description:The total tax amount of the document in the base currency. | ||||
TaxTotalWithRetainageNonexistent in DB | decimal? | Amount Due Total in Base Currency | - | |
Description:The tax amount of the document in the base currency. Calculated as the sum of TaxTotal and RetainageTaxTotal. | ||||
TaxZoneID | nvarchar(10) | Customer Tax Zone | TaxZone | |
Description:The identifier of the TaxZone associated with the document. Corresponds to the TaxZone.TaxZoneID field. | ||||
TermsID | nvarchar(10) | Terms | Terms | |
Description:The identifier of the credit terms object associated with the document. Defaults to the credit terms that are selected for the customer. The value corresponds to the value of the Terms.TermsID field. | ||||
TransactionalTotal | decimal | Time and Material Total in Base Currency | - | |
Description:The total amount to invoice of the time and material lines of the document in the base currency. | ||||
WorkgroupID | int | Workgroup | EPCompanyTree | |
Description:The workgroup that is responsible for the document. Corresponds to the EPCompanyTree.WorkGroupID field. | ||||
tstamp | timestamp | - | ||
Description:No description available | ||||