Stratus Aperture

API Family:Default

Version:23.200.001

Screen ID:PM307000

Properties

Select a row for its DAC field and description

	Property	Type	Data Type
	`AmountDue`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PM.PMProforma.CuryAmountDue` Description:The amount due. The difference between the Invoice Total and Retainage Total.
	`ApprovalDetails`	`List`	Approval
DAC Field:Not mapped to a DAC field Description:No description available
	`BillingSettings`	`BillToSettings`	BillToSettings
DAC Field:Not mapped to a DAC field Description:No description available
	`CurrencyID`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.CuryID` Description:The identifier of the pro forma invoice currency. The value of this field corresponds to the value of the Currency.CuryID field.
	`CustomerID`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.CustomerID` 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`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.Description` Description:The description of the pro forma invoice, which is provided by the billing rule and can be manually modified.
	`EffectiveDate`	`DateTimeValue`	DateTime
DAC Field:Not mapped to a DAC field Description:No description available
	`ExternalRefNbr`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.ExtRefNbr` Description:The reference number of the external document.
	`FinancialDetails`	`ProFormaFinancialDetails`	ProFormaFinancialDetails
DAC Field:Not mapped to a DAC field Description:No description available
	`Hold`	`BooleanValue`	boolean
DAC Field:`PX.Objects.PM.PMProforma.Hold` Description:Specifies (if set to true) that the document is on hold.
	`InvoiceDate`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.PM.PMProforma.InvoiceDate` Description:The date on which the pro forma invoice was created.
	`InvoiceTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PM.PMProforma.CuryDocTotal` Description:The invoice total. The sum of the progress billing total, time and material total, and tax total values.
	`LastModifiedDateTime`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.PM.PMProforma.LastModifiedDateTime` Description:No description available
	`Location`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.LocationID` 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.
	`PostPeriod`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.FinPeriodID` Description:The financial period that corresponds to the invoice date.
	`ProgressBilling`	`List`	ProgressBilling
DAC Field:Not mapped to a DAC field Description:No description available
	`ProgressBillingTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PM.PMProforma.CuryProgressiveTotal` Description:The total amount to invoice of the progress billing lines of the document.
	`ProjectID`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.ProjectID` 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.
	`RefNbr`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.RefNbr` 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.
	`RetainageTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PM.PMProforma.CuryRetainageTotal` Description:The total retained amount. Calculated as the sum of CuryRetainageDetailTotal and CuryRetainageTaxTotal.
	`Status`	`StringValue`	string
DAC Field:`PX.Objects.PM.PMProforma.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
	`TaxDetails`	`List`	ProFormaTaxDetail
DAC Field:Not mapped to a DAC field Description:No description available
	`TaxTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PM.PMProforma.CuryTaxTotal` Description:The total tax amount of the document.
	`TimeAndMaterial`	`List`	TimeAndMaterial
DAC Field:Not mapped to a DAC field Description:No description available
	`TimeAndMaterialTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.PM.PMProforma.CuryTransactionalTotal` Description:The total amount to invoice of the time and material lines of the document.

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

{
  "CustomerID": {
    "value": "string"
  },
  "Location": {
    "value": "string"
  },
  "ProjectID": {
    "value": "string"
  }
}

For every property this entity accepts, see the properties table.

Optional Children

None of these child collections is required — a payload without them is valid. If you do include one, these are the fields each row of it needs; keys the parent record supplies are named separately and must not be sent.

FinancialDetailsa nested ProFormaFinancialDetailsrequired if you include one:Branch
ProgressBillinga list of ProgressBillingrequired if you include one:SalesAccount
TaxDetailsa list of ProFormaTaxDetailrequired if you include one:TaxID

Available in Versions

25.200.001 24.200.001 23.200.001 22.200.001 20.200.001