Skip to main content
API Family:Default
Version:22.200.001
Screen ID:FS300200

Properties

Select a row for its DAC field
PropertyTypeData Type
ActualDurationStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.ActualDuration
Description:No description available
ActualEndDateDateTimeValueDateTime
DAC Field:Not mapped to a DAC field
Description:No description available
ActualEndTimeDateTimeValueDateTime
DAC Field:Not mapped to a DAC field
Description:No description available
ActualHandleManuallyBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.HandleManuallyActualTime
Description:No description available
ActualServiceDurationStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.ActualDurationTotal
Description:No description available
ActualStartDateDateTimeValueDateTime
DAC Field:PX.Objects.FS.FSAppointment.ExecutionDate
Description:No description available
ActualStartTimeDateTimeValueDateTime
DAC Field:Not mapped to a DAC field
Description:No description available
AppointmentNbrStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.RefNbr
Description:No description available
AppointmentTotalDecimalValuedecimal
DAC Field:PX.Objects.FS.FSAppointment.CuryDocTotal
Description:No description available
AttributesListAppAttributes
DAC Field:Not mapped to a DAC field
Description:No description available
BranchLocationStringValuestring
DAC Field:PX.Objects.FS.FSServiceOrder.BranchLocationID
Description:No description available
ConfirmedBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.Confirmed
Description:No description available
CostTotalDecimalValuedecimal
DAC Field:PX.Objects.FS.FSAppointment.CuryCostTotal
Description:No description available
CustomerStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.CustomerID
Description:No description available
DefaultProjectTaskStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.DfltProjectTaskID
Description:No description available
DescriptionStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.DocDesc
Description:No description available
DetailsListAppDetails
DAC Field:Not mapped to a DAC field
Description:No description available
EstimatedServiceDurationStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.EstimatedDurationTotal
Description:No description available
FinancialSettingsAppFinancialSettingsAppFinancialSettings
DAC Field:Not mapped to a DAC field
Description:No description available
FinishedBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.Finished
Description:No description available
HoldBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.Hold
Description:No description available
LocationStringValuestring
DAC Field:PX.Objects.FS.FSServiceOrder.LocationID
Description:No description available
LogsListAppLogs
DAC Field:Not mapped to a DAC field
Description:No description available
OptimizationResultStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.ROOptimizationStatus
Description:No description available
OtherInformationAppOtherInformationAppOtherInformation
DAC Field:Not mapped to a DAC field
Description:No description available
OverrideBooleanValueboolean
DAC Field:PX.Objects.FS.FSServiceOrder.AllowOverrideContactAddress
Description:No description available
PrepaymentsListAppPrepayments
DAC Field:Not mapped to a DAC field
Description:No description available
ProfitDecimalValuedecimal
DAC Field:PX.Objects.FS.FSAppointment.ProfitPercent
Description:No description available
ProfitabilityListAppProfitability
DAC Field:Not mapped to a DAC field
Description:No description available
ProjectStringValuestring
DAC Field:PX.Objects.FS.FSServiceOrder.ProjectID
Description:No description available
ResourceEquipmentListAppResourceEquipment
DAC Field:Not mapped to a DAC field
Description:No description available
ScheduledDurationStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.ScheduledDuration
Description:No description available
ScheduledEndDateDateTimeValueDateTime
DAC Field:Not mapped to a DAC field
Description:No description available
ScheduledEndTimeDateTimeValueDateTime
DAC Field:Not mapped to a DAC field
Description:No description available
ScheduledHandleManuallyBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.HandleManuallyScheduleTime
Description:No description available
ScheduledStartDateDateTimeValueDateTime
DAC Field:Not mapped to a DAC field
Description:No description available
ScheduledStartTimeDateTimeValueDateTime
DAC Field:Not mapped to a DAC field
Description:No description available
ServiceOrderNbrStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.SORefNbr
Description:No description available
ServiceOrderTypeStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.SrvOrdType
Description:No description available
StaffListAppStaff
DAC Field:Not mapped to a DAC field
Description:No description available
StatusStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.Status
Description:No description available
TaxDetailsListAppTaxDetails
DAC Field:Not mapped to a DAC field
Description:No description available
TaxTotalDecimalValuedecimal
DAC Field:PX.Objects.FS.FSAppointment.CuryTaxTotal
Description:No description available
TotalsAppTotalsAppTotals
DAC Field:Not mapped to a DAC field
Description:No description available
UnreachedCustomerBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.UnreachedCustomer
Description:No description available
ValidatedbyDispatcherBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.ValidatedByDispatcher
Description:No description available
WaitingforPurchasedItemsBooleanValueboolean
DAC Field:PX.Objects.FS.FSAppointment.WaitingForParts
Description:No description available
WorkflowStageStringValuestring
DAC Field:PX.Objects.FS.FSAppointment.WFStageID
Description:No description available

Minimum Payload

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

3 required fields
{
  "ActualStartDate": {
    "value": "2025-01-01T00:00:00Z"
  },
  "Customer": {
    "value": "string"
  },
  "Project": {
    "value": "string"
  },
  "Details": [
    {
      "LineType": {
        "value": "string"
      }
    }
  ]
}

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

Details is the detail-lines collection (AppDetails); one example row is included above because a document usually has lines, and each row needs LineType of its own.

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.

  • Attributesa list of AppAttributesrequired if you include one:Attribute
  • FinancialSettingsa nested AppFinancialSettingsrequired if you include one:BillingCycle
  • Logsa list of AppLogsrequired if you include one:EarningTypesupplied by the parent:AppointmentNbr
  • Prepaymentsa list of AppPrepaymentsrequired if you include one:Type
  • Profitabilitya list of AppProfitabilityrequired if you include one:LineType
  • ResourceEquipmenta list of AppResourceEquipmentrequired if you include one:EquipmentIDsupplied by the parent:AppointmentNbr
  • Staffa list of AppStaffrequired if you include one:StaffMembersupplied by the parent:AppointmentNbr
  • TaxDetailsa list of AppTaxDetailsrequired if you include one:TaxIDsupplied by the parent:AppointmentNbr

Available in Versions