{ "customer_id",// nullable | required, if is_template is false or not set | integer | existing customer id | prohibited when is_template is true "title",// required | string | max:255 "status_id",// required | integer | existing custom status id | description: object type maintenance_agreement "status_workflow_id",// nullable | integer | existing status workflow id | description: object type maintenance_agreement "customer_contact_id",// nullable | integer | existing customer contact id | prohibited when is_template is true "parent_invoice_id",// nullable | integer | existing invoice id | description: not a template, and the agreement customer when a customer is set "timezone",// nullable | string | description: PHP timezone identifier "start_time",// nullable | integer | description: timestamp. A date string is also accepted. "end_time",// nullable | integer | description: timestamp, same as or after start_time. A date string is also accepted. "job_location",// nullable | string | max:255 "agreement_notes",// nullable | string "job_notes",// nullable | string "is_template",// nullable | boolean "asset_ids",// nullable | array | description: array of existing asset ids "settings",// nullable | array | description: stored as sent. No child-key rules. "tags",// nullable | array | description: tag ids, or objects {"id": tag id}. Type must be maintenance_agreement. "assignments": [// nullable | array | description: teams only. Each team is expanded to one assignment per member. { "team_id",// required | integer | existing team id } ], "location_id",// nullable | integer | existing location id | prohibited when is_template is true | description: a location of the agreement customer "parent_job_id",// nullable | integer | existing job id | description: not a template, and the agreement customer when a customer is set "services_routines": [// required, if billing_routines is not set | array | max:5 | description: full list. An active agreement requires at least one. A scheduled routine cannot carry on_demand_generation_method. An on-demand routine cannot carry schedule_generation_method. { "id",// nullable | integer | existing service routine id | description: omit to create "title",// required | string | max:255 "rrule",// required, if type is scheduled | nullable | string | description: valid rrule "type",// required | string | acceptable_values: scheduled,on-demand "asset_ids",// nullable | array | description: array of existing asset ids "schedule_generation_method": {// required, if type is scheduled | prohibited, if type is on-demand | array "creation_method",// required, if schedule_generation_method is set | nullable | string | acceptable_values: manual,automatic "automatic_creation_method",// required, if schedule_generation_method is set | string | acceptable_values: automatic,find-availability,fixed "generation_window_in_month",// required, if schedule_generation_method is set | integer | acceptable_values: 1,2,3,6,12,13,18,24 "set_job_template",// nullable | boolean | description: must be true when automatic_creation_method is fixed "job_template_id",// required, if set_job_template is true | nullable | integer | existing job template id "fixed_method_rrule",// required, if automatic_creation_method is fixed | nullable | string | description: valid rrule with no start or end "scheduled_details",// required, if automatic_creation_method is find-availability | nullable | array | description: stored as sent. No child-key rules. }, "on_demand_generation_method": {// required, if type is on-demand | prohibited, if type is scheduled | array "generation_window_in_month",// required, if on_demand_generation_method is set | integer | min:1 "amount_of_services",// required, if on_demand_generation_method is set | integer | min:1 "unused_services_policy",// required, if on_demand_generation_method is set | string | acceptable_values: expire,rollover "set_job_template",// nullable | boolean "job_template_id",// required, if set_job_template is true | nullable | integer | existing job template id }, "initial_occurrence_job_id",// nullable | integer | existing job id | description: create only. The job already booked for the first occurrence. } ], "services_routine_overlaps": [// optional | array | description: dropped unless both indexed routines are scheduled and creation_method is automatic. One overlap per pair. { "id",// nullable | integer | existing overlap id "first_routine_index",// required | integer | min:0 | description: index in services_routines "second_routine_index",// required | integer | min:0 | description: a different services_routines index. The pair may appear only once. "generation_method": {// required | array "creation_method",// nullable | string | acceptable_values: manual,automatic "automatic_creation_method",// required | string | acceptable_values: automatic,find-availability,fixed "generation_window_in_month",// required | integer | acceptable_values: 1,2,3,6,12,13,18,24 "set_job_template",// nullable | boolean | description: must be true when automatic_creation_method is fixed "job_template_id",// required, if set_job_template is true | nullable | integer | existing job template id "fixed_method_rrule",// required, if automatic_creation_method is fixed | nullable | string | description: valid rrule with no start or end "scheduled_details",// required, if automatic_creation_method is find-availability | nullable | array | description: stored as sent. No child-key rules. } } ], "communication": [// optional | array | description: full list. Triggers omitted from the payload are deleted. { "id",// nullable | integer | existing communication trigger id "send_type",// required | string | acceptable_values: email,sms "target_routine_mode",// required | string | acceptable_values: all,multiple,single "type",// nullable | string | acceptable_values: reminder,renewal "routine_indexes",// required, if target_routine_mode is single or multiple | nullable | array | description: services_routines indexes. Exactly one when target_routine_mode is single. Not checked when target_routine_mode is all. "notify_before_date_in_days",// required | integer | min:0 "scheduled_statuses",// nullable | array | description: acceptable values draft,unscheduled,scheduled,completed,failed. Stored as a comma-separated string. "user_to_send",// nullable | array | description: array of existing user ids. Stored as a comma-separated string. "email_subject",// required, if send_type is email | nullable | string | max:255 "body",// required | string "send_to_users",// required | boolean "send_to_customer",// required | boolean } ], "billing_routines": [// optional | array | max:1 | description: an active agreement requires exactly one { "id",// nullable | integer | existing billing routine id "title",// required | string | max:255 "creation_method",// required | string | acceptable_values: manual,recurring-billing "rrule",// required, if creation_method is manual | nullable | string | description: valid rrule "recurring_billing_id",// required, if creation_method is recurring-billing | prohibited, if creation_method is manual | nullable | integer | existing recurring billing id "price_per_bill",// required | numeric | min:0 "generation_window_in_month",// required | integer | min:1 "initial_occurrence_estimate_id",// nullable | integer | existing estimate id | description: mutually exclusive with initial_occurrence_invoice_id "initial_occurrence_invoice_id",// nullable | integer | existing invoice id | description: create only. Mutually exclusive with initial_occurrence_estimate_id. } ], "customfields": [// nullable | array | description: array of custom fields { "id",// nullable | required, if field_instance_id is not set | integer | existing custom field instance id "field_instance_id",// nullable | required, if id is not set | integer | existing custom field instance id "value",// nullable | description: must match the custom field type when set } ], "template_id",// nullable | integer | existing maintenance agreement template id "engage_call_to_records": [// optional | array | description: create only. At most one item may be the primary call. { "engage_call_id",// required | string | max:255 "is_primary_call",// nullable | boolean "lead_source_id",// nullable | integer | existing lead source id } ]}
Authorizations
x-api-key
string
header
required
Body
application/json
title
string
required
Maximum string length: 255
status_id
integer
required
Object type maintenance_agreement. Existing custom status id.
customer_id
integer | null
Required if is_template is false or not set. Existing customer id. Prohibited when is_template is true.
status_workflow_id
integer | null
Object type maintenance_agreement. Existing status workflow id.
customer_contact_id
integer | null
Existing customer contact id. Prohibited when is_template is true.
parent_invoice_id
integer | null
Not a template, and the agreement customer when a customer is set. Existing invoice id.
timezone
string | null
PHP timezone identifier.
start_time
integer | null
Timestamp. A date string is also accepted.
end_time
integer | null
Timestamp, same as or after start_time. A date string is also accepted.
job_location
string | null
Maximum string length: 255
agreement_notes
string | null
job_notes
string | null
is_template
boolean | null
asset_ids
integer[] | null
Array of existing asset ids.
settings
any[] | null
Stored as sent. No child-key rules.
tags
integer[] | null
Tag ids, or objects {"id": tag id}. Type must be maintenance_agreement.
assignments
object[] | null
Teams only. Each team is expanded to one assignment per member.
Hide child attributes
assignments.team_id
integer
required
Existing team id.
location_id
integer | null
A location of the agreement customer. Existing location id. Prohibited when is_template is true.
parent_job_id
integer | null
Not a template, and the agreement customer when a customer is set. Existing job id.
services_routines
object[]
Full list. An active agreement requires at least one. A scheduled routine cannot carry on_demand_generation_method. An on-demand routine cannot carry schedule_generation_method. Required if billing_routines is not set.
Maximum array length: 5
Hide child attributes
services_routines.title
string
required
Maximum string length: 255
services_routines.type
enum<string>
required
Available options:
scheduled,
on-demand
services_routines.id
integer | null
Omit to create. Existing service routine id.
services_routines.rrule
string | null
Valid rrule. Required if type is scheduled.
services_routines.asset_ids
integer[] | null
Array of existing asset ids.
services_routines.schedule_generation_method
object
Required if type is scheduled. Prohibited, if type is on-demand.
Stored as sent. No child-key rules. Required if automatic_creation_method is find-availability.
services_routine_overlaps.id
integer | null
Existing overlap id.
communication
object[]
Full list. Triggers omitted from the payload are deleted.
Hide child attributes
communication.send_type
enum<string>
required
Available options:
email,
sms
communication.target_routine_mode
enum<string>
required
Available options:
all,
multiple,
single
communication.notify_before_date_in_days
integer
required
Required range: x >= 0
communication.body
string
required
communication.send_to_users
boolean
required
communication.send_to_customer
boolean
required
communication.id
integer | null
Existing communication trigger id.
communication.type
enum<string> | null
Available options:
reminder,
renewal
communication.routine_indexes
any[] | null
Services_routines indexes. Exactly one when target_routine_mode is single. Not checked when target_routine_mode is all. Required if target_routine_mode is single or multiple.
communication.scheduled_statuses
any[] | null
Acceptable values draft,unscheduled,scheduled,completed,failed. Stored as a comma-separated string.
communication.user_to_send
integer[] | null
Array of existing user ids. Stored as a comma-separated string.
communication.email_subject
string | null
Required if send_type is email.
Maximum string length: 255
billing_routines
object[]
An active agreement requires exactly one.
Maximum array length: 1
Hide child attributes
billing_routines.title
string
required
Maximum string length: 255
billing_routines.creation_method
enum<string>
required
Available options:
manual,
recurring-billing
billing_routines.price_per_bill
number
required
Required range: x >= 0
billing_routines.generation_window_in_month
integer
required
Required range: x >= 1
billing_routines.id
integer | null
Existing billing routine id.
billing_routines.rrule
string | null
Valid rrule. Required if creation_method is manual.
billing_routines.recurring_billing_id
integer | null
Required if creation_method is recurring-billing. Prohibited, if creation_method is manual. Existing recurring billing id.
billing_routines.initial_occurrence_estimate_id
integer | null
Mutually exclusive with initial_occurrence_invoice_id. Existing estimate id.
billing_routines.initial_occurrence_invoice_id
integer | null
Create only. Mutually exclusive with initial_occurrence_estimate_id. Existing invoice id.
customfields
object[] | null
Array of custom fields.
Hide child attributes
customfields.id
integer | null
Required if field_instance_id is not set. Existing custom field instance id.
customfields.field_instance_id
integer | null
Required if id is not set. Existing custom field instance id.
customfields.value
string | null
Must match the custom field type when set.
template_id
integer | null
Existing maintenance agreement template id.
engage_call_to_records
object[]
Create only. At most one item may be the primary call.
Hide child attributes
engage_call_to_records.engage_call_id
string
required
Maximum string length: 255
engage_call_to_records.is_primary_call
boolean | null
engage_call_to_records.lead_source_id
integer | null
Existing lead source id.
Response
200 - application/json
Successful response
error
boolean
false when the request succeeds.
Example:
false
response
object
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FieldPulse Help Center","description":"Product documentation for the FieldPulse field service management platform.","colors":{"primary":"#00034D","light":"#488BD6","dark":"#0007B3"},"logo":{"light":"https://mintcdn.com/fieldpulse/iDqY8C4IxwE4NJKJ/static/logo/fieldpulse-help-center-white.svg?fit=max\u0026auto=format\u0026n=iDqY8C4IxwE4NJKJ\u0026q=85\u0026s=0d5929b317daa1fc26a72a003418aca4","dark":"https://mintcdn.com/fieldpulse/iDqY8C4IxwE4NJKJ/static/logo/fieldpulse-help-center-white.svg?fit=max\u0026auto=format\u0026n=iDqY8C4IxwE4NJKJ\u0026q=85\u0026s=0d5929b317daa1fc26a72a003418aca4","href":"/"},"favicon":"https://mintcdn.com/fieldpulse/GXkiuT83YA_xAzj5/favicon.png?fit=max\u0026auto=format\u0026n=GXkiuT83YA_xAzj5\u0026q=85\u0026s=0549b7a01463208f2106bec4727194bb","api":{"params":{"expanded":"all"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true}},"appearance":{"default":"light","strict":true},"background":{"color":{"light":"#F5F5F1","dark":"#0A0F1E"}},"navbar":{"links":[{"href":"https://webapp.fieldpulse.com","label":"Login"}]},"footer":{"socials":{"facebook":"https://www.facebook.com/fieldpulse","youtube":"https://www.youtube.com/@FieldPulse","linkedin":"https://www.linkedin.com/company/fieldpulse","instagram":"https://www.instagram.com/fieldpulse"},"links":[{"header":"Features","items":[{"label":"Scheduling \u0026 Dispatching","href":"https://www.fieldpulse.com/features/scheduling-and-dispatching"},{"label":"Estimates \u0026 Invoices","href":"https://www.fieldpulse.com/features/estimates-and-invoices"},{"label":"Customer Management","href":"https://www.fieldpulse.com/features/customer-management"},{"label":"Job Management","href":"https://www.fieldpulse.com/features/job-management"},{"label":"Pricebook","href":"https://www.fieldpulse.com/features/pricebook"},{"label":"Inventory Management","href":"https://www.fieldpulse.com/features/inventory-management"}]},{"header":"Product","items":[{"label":"Product Overview","href":"https://www.fieldpulse.com/features"},{"label":"Pricing","href":"https://www.fieldpulse.com/pricing"},{"label":"ClearPath","href":"https://www.fieldpulse.com/features/clearpath"},{"label":"Field Intelligence","href":"https://www.fieldpulse.com/features/field-intelligence"}]},{"header":"Company","items":[{"label":"Our Mission","href":"https://www.fieldpulse.com/company"},{"label":"Partners","href":"https://www.fieldpulse.com/company/partners"},{"label":"Careers","href":"https://www.fieldpulse.com/company/careers"},{"label":"Contact","href":"https://www.fieldpulse.com/company/contact-us"}]},{"header":"Resources","items":[{"label":"Help Center","href":"https://help.fieldpulse.com"},{"label":"Customer Stories","href":"https://www.fieldpulse.com/resources/customer-stories"},{"label":"Blog","href":"https://www.fieldpulse.com/resources/blog"},{"label":"FAQ","href":"https://www.fieldpulse.com/resources/faq"}]}]},"search":{"prompt":"Search FieldPulse docs..."},"seo":{"metatags":{"og:site_name":"FieldPulse Help Center","twitter:card":"summary_large_image","twitter:site":"@FieldPulseApp"},"paths":[{"path":"es","metatags":{"og:locale":"es_MX"}}],"organization":{"id":"https://www.fieldpulse.com/#organization","name":"FieldPulse","url":"https://www.fieldpulse.com","logo":"https://help.fieldpulse.com/static/logo/fieldpulse-organization-logo.png","sameAs":["https://www.linkedin.com/company/fieldpulse/","https://www.youtube.com/@Fieldpulse","https://www.facebook.com/fieldpulse/","https://www.instagram.com/fieldpulse/"]}},"fonts":{"heading":{"family":"Montserrat","weight":700},"body":{"family":"Montserrat","weight":500}},"integrations":{"ga4":{"measurementId":"G-CLLX0BT4J3"}},"contextual":{"options":["copy","view","assistant"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/fieldpulse/BhNcub0WV4eGdGDx/static/images/og-background.png?fit=max\u0026auto=format\u0026n=BhNcub0WV4eGdGDx\u0026q=85\u0026s=c62d13fabb1195496ae47e974fedee69","fonts":{"family":"Montserrat"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"es","banner":{"content":"Algunas páginas aún están solo en inglés. [Ver el centro de ayuda en inglés](/).","dismissible":true},"footer":{"socials":{"facebook":"https://www.facebook.com/fieldpulse","youtube":"https://www.youtube.com/@FieldPulse","linkedin":"https://www.linkedin.com/company/fieldpulse","instagram":"https://www.instagram.com/fieldpulse"},"links":[{"header":"Funciones","items":[{"label":"Programación y despacho","href":"https://www.fieldpulse.com/features/scheduling-and-dispatching"},{"label":"Presupuestos y facturas","href":"https://www.fieldpulse.com/features/estimates-and-invoices"},{"label":"Administración de clientes","href":"https://www.fieldpulse.com/features/customer-management"},{"label":"Administración de trabajos","href":"https://www.fieldpulse.com/features/job-management"},{"label":"Catálogo de precios","href":"https://www.fieldpulse.com/features/pricebook"},{"label":"Administración de inventario","href":"https://www.fieldpulse.com/features/inventory-management"}]},{"header":"Producto","items":[{"label":"Descripción general del producto","href":"https://www.fieldpulse.com/features"},{"label":"Precios","href":"https://www.fieldpulse.com/pricing"},{"label":"ClearPath","href":"https://www.fieldpulse.com/features/clearpath"},{"label":"Field Intelligence","href":"https://www.fieldpulse.com/features/field-intelligence"}]},{"header":"Empresa","items":[{"label":"Nuestra misión","href":"https://www.fieldpulse.com/company"},{"label":"Socios","href":"https://www.fieldpulse.com/company/partners"},{"label":"Empleos","href":"https://www.fieldpulse.com/company/careers"},{"label":"Contacto","href":"https://www.fieldpulse.com/company/contact-us"}]},{"header":"Recursos","items":[{"label":"Centro de ayuda","href":"https://help.fieldpulse.com"},{"label":"Casos de éxito","href":"https://www.fieldpulse.com/resources/customer-stories"},{"label":"Blog","href":"https://www.fieldpulse.com/resources/blog"},{"label":"Preguntas frecuentes","href":"https://www.fieldpulse.com/resources/faq"}]}]},"navbar":{"links":[{"href":"/es/changelog","label":"Novedades"},{"href":"/api-reference/overview","label":"Referencia de la API (en inglés)"},{"href":"/","label":"Ver en inglés"},{"href":"https://webapp.fieldpulse.com","label":"Iniciar sesión"}]},"href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fieldpulse","hasAudioNarration":true,"actualSubdomain":"fieldpulse","customDomains":["help.fieldpulse.com"],"gitSource":{"type":"github","owner":"flicent","repo":"fieldpulse-help-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00aafa0ec82cf37ce414d4","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"en","tag":"Home","count":454},{"language":"en","tag":"API Reference","count":127},{"language":"en","tag":"Add-Ons \u0026 Premium","count":67},{"language":"es","tag":"Complementos y funciones premium","count":67},{"language":"en","tag":"Integrations","count":66},{"language":"es","tag":"Integraciones","count":66},{"language":"en","tag":"Jobs, Projects \u0026 Field Work","count":48},{"language":"es","tag":"Trabajos, proyectos y trabajo de campo","count":48},{"language":"en","tag":"Training \u0026 Resources","count":41},{"language":"es","tag":"Capacitación y recursos","count":40},{"language":"en","tag":"Engage Phone System","count":38},{"language":"es","tag":"Sistema telefónico Engage","count":38},{"language":"en","tag":"FieldPulse360","count":35},{"language":"es","tag":"FieldPulse360","count":35},{"language":"en","tag":"FieldPulse360 Archives","count":33},{"language":"es","tag":"Archivo de FieldPulse360","count":33},{"language":"en","tag":"Reporting \u0026 Analytics","count":32},{"language":"es","tag":"Reportes y análisis","count":32},{"language":"es","tag":"Estimados y facturas","count":31},{"language":"es","tag":"Equipo de trabajo, cuenta y configuración","count":31}],"searchSettings":{"showContentSnippets":true,"maxResults":5,"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@fieldpulse.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","href":"/_mintlify/custom/fieldpulse/103e47ce1c2975c8/styles.css"}]}
{"page":{"pagePath":"api-reference/maintenance-agreements/create-maintenance-agreement","slug":"/api-reference/maintenance-agreements/create-maintenance-agreement","pageMetadata":{"openapi":"post /maintenance-agreements","title":"Create Maintenance Agreement","description":null,"href":"/api-reference/maintenance-agreements/create-maintenance-agreement"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsx(CodeBlock,{filename:`Body raw (json)`,wrap:`true`,expandable:`true`,numberOfLines:`111`,language:`jsonc`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`jsonc`,children:_jsxs(_components.code,{language:`jsonc`,numberOfLines:`111`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customer_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | required, if is_template is false or not set | integer | existing customer id | prohibited when is_template is true`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | max:255`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | integer | existing custom status id | description: object type maintenance_agreement`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status_workflow_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing status workflow id | description: object type maintenance_agreement`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customer_contact_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing customer contact id | prohibited when is_template is true`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"parent_invoice_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing invoice id | description: not a template, and the agreement customer when a customer is set`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timezone\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | string | description: PHP timezone identifier`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"start_time\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | description: timestamp. A date string is also accepted.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"end_time\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | description: timestamp, same as or after start_time. A date string is also accepted.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"job_location\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | string | max:255`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agreement_notes\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | string`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"job_notes\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | string`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_template\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | boolean`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"asset_ids\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: array of existing asset ids`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"settings\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: stored as sent. No child-key rules.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tags\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: tag ids, or objects {\"id\": tag id}. Type must be maintenance_agreement.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"assignments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: teams only. Each team is expanded to one assignment per member.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"team_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | integer | existing team id`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"location_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing location id | prohibited when is_template is true | description: a location of the agreement customer`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"parent_job_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing job id | description: not a template, and the agreement customer when a customer is set`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"services_routines\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if billing_routines is not set | array | max:5 | description: full list. An active agreement requires at least one. A scheduled routine cannot carry on_demand_generation_method. An on-demand routine cannot carry schedule_generation_method.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing service routine id | description: omit to create`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | max:255`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"rrule\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if type is scheduled | nullable | string | description: valid rrule`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | acceptable_values: scheduled,on-demand`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"asset_ids\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: array of existing asset ids`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schedule_generation_method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if type is scheduled | prohibited, if type is on-demand | array`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"creation_method\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if schedule_generation_method is set | nullable | string | acceptable_values: manual,automatic`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"automatic_creation_method\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if schedule_generation_method is set | string | acceptable_values: automatic,find-availability,fixed`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"generation_window_in_month\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if schedule_generation_method is set | integer | acceptable_values: 1,2,3,6,12,13,18,24`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"set_job_template\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | boolean | description: must be true when automatic_creation_method is fixed`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"job_template_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if set_job_template is true | nullable | integer | existing job template id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fixed_method_rrule\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if automatic_creation_method is fixed | nullable | string | description: valid rrule with no start or end`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scheduled_details\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if automatic_creation_method is find-availability | nullable | array | description: stored as sent. No child-key rules.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"on_demand_generation_method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if type is on-demand | prohibited, if type is scheduled | array`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"generation_window_in_month\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if on_demand_generation_method is set | integer | min:1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount_of_services\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if on_demand_generation_method is set | integer | min:1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"unused_services_policy\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if on_demand_generation_method is set | string | acceptable_values: expire,rollover`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"set_job_template\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | boolean`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"job_template_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if set_job_template is true | nullable | integer | existing job template id`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"initial_occurrence_job_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing job id | description: create only. The job already booked for the first occurrence.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"services_routine_overlaps\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// optional | array | description: dropped unless both indexed routines are scheduled and creation_method is automatic. One overlap per pair.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing overlap id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"first_routine_index\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | integer | min:0 | description: index in services_routines`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"second_routine_index\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | integer | min:0 | description: a different services_routines index. The pair may appear only once.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"generation_method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | array`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"creation_method\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | string | acceptable_values: manual,automatic`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"automatic_creation_method\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | acceptable_values: automatic,find-availability,fixed`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"generation_window_in_month\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | integer | acceptable_values: 1,2,3,6,12,13,18,24`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"set_job_template\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | boolean | description: must be true when automatic_creation_method is fixed`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"job_template_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if set_job_template is true | nullable | integer | existing job template id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fixed_method_rrule\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if automatic_creation_method is fixed | nullable | string | description: valid rrule with no start or end`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scheduled_details\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if automatic_creation_method is find-availability | nullable | array | description: stored as sent. No child-key rules.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"communication\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// optional | array | description: full list. Triggers omitted from the payload are deleted.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing communication trigger id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"send_type\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | acceptable_values: email,sms`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"target_routine_mode\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | acceptable_values: all,multiple,single`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | string | acceptable_values: reminder,renewal`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"routine_indexes\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if target_routine_mode is single or multiple | nullable | array | description: services_routines indexes. Exactly one when target_routine_mode is single. Not checked when target_routine_mode is all.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"notify_before_date_in_days\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | integer | min:0`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scheduled_statuses\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: acceptable values draft,unscheduled,scheduled,completed,failed. Stored as a comma-separated string.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"user_to_send\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: array of existing user ids. Stored as a comma-separated string.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email_subject\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if send_type is email | nullable | string | max:255`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"body\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"send_to_users\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | boolean`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"send_to_customer\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | boolean`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"billing_routines\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// optional | array | max:1 | description: an active agreement requires exactly one`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing billing routine id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | max:255`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"creation_method\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | acceptable_values: manual,recurring-billing`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"rrule\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if creation_method is manual | nullable | string | description: valid rrule`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"recurring_billing_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required, if creation_method is recurring-billing | prohibited, if creation_method is manual | nullable | integer | existing recurring billing id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"price_per_bill\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | numeric | min:0`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"generation_window_in_month\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | integer | min:1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"initial_occurrence_estimate_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing estimate id | description: mutually exclusive with initial_occurrence_invoice_id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"initial_occurrence_invoice_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing invoice id | description: create only. Mutually exclusive with initial_occurrence_estimate_id.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customfields\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | array | description: array of custom fields`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | required, if field_instance_id is not set | integer | existing custom field instance id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"field_instance_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | required, if id is not set | integer | existing custom field instance id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"value\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | description: must match the custom field type when set`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"template_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing maintenance agreement template id`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"engage_call_to_records\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// optional | array | description: create only. At most one item may be the primary call.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"engage_call_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// required | string | max:255`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_primary_call\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | boolean`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lead_source_id\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`,`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// nullable | integer | existing lead source id`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /maintenance-agreements","title":"Create Maintenance Agreement","description":null,"href":"/api-reference/maintenance-agreements/create-maintenance-agreement"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fieldpulse/18c25a0209d16476/footer-nav.js","/_mintlify/custom/fieldpulse/e48aee707fc9fd8e/navbar-scroll.js","/_mintlify/custom/fieldpulse/f932709279178dcc/landing-nav.js","/_mintlify/custom/fieldpulse/3af6c13a2714037e/article-data.js","/_mintlify/custom/fieldpulse/b1ff9594d3bed9e4/category-cards.js","/_mintlify/custom/fieldpulse/af31e68fdd949a89/docs-sidebar.js","/_mintlify/custom/fieldpulse/b165c344fc190c8e/article-breadcrumb.js","/_mintlify/custom/fieldpulse/572069c1f34ac807/sidebar-nav-data.js","/_mintlify/custom/fieldpulse/b33729ec9687c66f/mobile-toc.js","/_mintlify/custom/fieldpulse/c85eba28fb81eb80/landing-mobile-nav.js","/_mintlify/custom/fieldpulse/dce687a2c0afcee8/ask-assistant-fab.js","/_mintlify/custom/fieldpulse/e5f94e8e4a6ceab1/article-index-es.js","/_mintlify/custom/fieldpulse/dc594876e2b5f5a1/fp-i18n.js"],"openApiReferenceData":{"operation":{"tags":["Maintenance Agreements"],"summary":"Create Maintenance Agreement","requestBody":"74988294-7454-4216-b70b-ce40287d3ad6","responses":{"200":"31a2fb79-7e94-48d7-9bb7-5cff9106bfb4"},"operationId":"postMaintenanceAgreements","method":"post","type":"path","servers":["27e25b33-33a0-4c47-8f43-0a517e5eb563"],"security":["24e9ebec-eb55-4aad-ad91-7d676e582d36"],"path":"/maintenance-agreements","baseUrlOptions":["https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage"],"title":"Create Maintenance Agreement","description":"","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.title":"some string","body.status_id":1,"body.customer_id.oneOf.0":1,"body.status_workflow_id.oneOf.0":1,"body.customer_contact_id.oneOf.0":1,"body.parent_invoice_id.oneOf.0":1,"body.timezone.oneOf.0":"some string","body.start_time.oneOf.0":1,"body.end_time.oneOf.0":1,"body.job_location.oneOf.0":"some string","body.agreement_notes.oneOf.0":"some string","body.job_notes.oneOf.0":"some string","body.is_template.oneOf.0":true,"body.asset_ids.oneOf.0.items.0":1,"body.tags.oneOf.0.items.0":1,"body.assignments.oneOf.0.items.0.team_id":1,"body.location_id.oneOf.0":1,"body.parent_job_id.oneOf.0":1,"body.services_routines.items.0.title":"some string","body.services_routines.items.0.type":"scheduled","body.services_routines.items.0.id.oneOf.0":1,"body.services_routines.items.0.rrule.oneOf.0":"some string","body.services_routines.items.0.asset_ids.oneOf.0.items.0":1,"body.services_routines.items.0.schedule_generation_method.creation_method.oneOf.0":"manual","body.services_routines.items.0.schedule_generation_method.automatic_creation_method":"automatic","body.services_routines.items.0.schedule_generation_method.generation_window_in_month":1,"body.services_routines.items.0.schedule_generation_method.set_job_template.oneOf.0":true,"body.services_routines.items.0.schedule_generation_method.job_template_id.oneOf.0":1,"body.services_routines.items.0.schedule_generation_method.fixed_method_rrule.oneOf.0":"some string","body.services_routines.items.0.on_demand_generation_method.generation_window_in_month":1,"body.services_routines.items.0.on_demand_generation_method.amount_of_services":1,"body.services_routines.items.0.on_demand_generation_method.unused_services_policy":"expire","body.services_routines.items.0.on_demand_generation_method.set_job_template.oneOf.0":true,"body.services_routines.items.0.on_demand_generation_method.job_template_id.oneOf.0":1,"body.services_routines.items.0.initial_occurrence_job_id.oneOf.0":1,"body.services_routine_overlaps.items.0.first_routine_index":1,"body.services_routine_overlaps.items.0.second_routine_index":1,"body.services_routine_overlaps.items.0.generation_method.automatic_creation_method":"automatic","body.services_routine_overlaps.items.0.generation_method.generation_window_in_month":1,"body.services_routine_overlaps.items.0.generation_method.creation_method.oneOf.0":"manual","body.services_routine_overlaps.items.0.generation_method.set_job_template.oneOf.0":true,"body.services_routine_overlaps.items.0.generation_method.job_template_id.oneOf.0":1,"body.services_routine_overlaps.items.0.generation_method.fixed_method_rrule.oneOf.0":"some string","body.services_routine_overlaps.items.0.id.oneOf.0":1,"body.communication.items.0.send_type":"email","body.communication.items.0.target_routine_mode":"all","body.communication.items.0.notify_before_date_in_days":1,"body.communication.items.0.body":"some string","body.communication.items.0.send_to_users":true,"body.communication.items.0.send_to_customer":true,"body.communication.items.0.id.oneOf.0":1,"body.communication.items.0.type.oneOf.0":"reminder","body.communication.items.0.user_to_send.oneOf.0.items.0":1,"body.communication.items.0.email_subject.oneOf.0":"some string","body.billing_routines.items.0.title":"some string","body.billing_routines.items.0.creation_method":"manual","body.billing_routines.items.0.price_per_bill":1,"body.billing_routines.items.0.generation_window_in_month":1,"body.billing_routines.items.0.id.oneOf.0":1,"body.billing_routines.items.0.rrule.oneOf.0":"some string","body.billing_routines.items.0.recurring_billing_id.oneOf.0":1,"body.billing_routines.items.0.initial_occurrence_estimate_id.oneOf.0":1,"body.billing_routines.items.0.initial_occurrence_invoice_id.oneOf.0":1,"body.customfields.oneOf.0.items.0.id.oneOf.0":1,"body.customfields.oneOf.0.items.0.field_instance_id.oneOf.0":1,"body.customfields.oneOf.0.items.0.value.oneOf.0":"some string","body.template_id.oneOf.0":1,"body.engage_call_to_records.items.0.engage_call_id":"some string","body.engage_call_to_records.items.0.is_primary_call.oneOf.0":true,"body.engage_call_to_records.items.0.lead_source_id.oneOf.0":1}]},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status_id":{"type":"integer","description":"Object type maintenance_agreement. Existing custom status id.","isRequired":true,"uniqueKey":"status_id","typeLabel":"integer"},"customer_id":{"oneOf":[{"type":"integer","description":"Required if is_template is false or not set. Existing customer id. Prohibited when is_template is true.","uniqueKey":"customer_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Required if is_template is false or not set. Existing customer id. Prohibited when is_template is true.","uniqueKey":"customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_id","typeLabel":"integer | null"},"status_workflow_id":{"oneOf":[{"type":"integer","description":"Object type maintenance_agreement. Existing status workflow id.","uniqueKey":"status_workflow_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Object type maintenance_agreement. Existing status workflow id.","uniqueKey":"status_workflow_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_workflow_id","typeLabel":"integer | null"},"customer_contact_id":{"oneOf":[{"type":"integer","description":"Existing customer contact id. Prohibited when is_template is true.","uniqueKey":"customer_contact_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Existing customer contact id. Prohibited when is_template is true.","uniqueKey":"customer_contact_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_contact_id","typeLabel":"integer | null"},"parent_invoice_id":{"oneOf":[{"type":"integer","description":"Not a template, and the agreement customer when a customer is set. Existing invoice id.","uniqueKey":"parent_invoice_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Not a template, and the agreement customer when a customer is set. Existing invoice id.","uniqueKey":"parent_invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_invoice_id","typeLabel":"integer | null"},"timezone":{"oneOf":[{"type":"string","description":"PHP timezone identifier.","uniqueKey":"timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"PHP timezone identifier.","uniqueKey":"timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"timezone","typeLabel":"string | null"},"start_time":{"oneOf":[{"type":"integer","description":"Timestamp. A date string is also accepted.","uniqueKey":"start_time.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Timestamp. A date string is also accepted.","uniqueKey":"start_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"start_time","typeLabel":"integer | null"},"end_time":{"oneOf":[{"type":"integer","description":"Timestamp, same as or after start_time. A date string is also accepted.","uniqueKey":"end_time.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Timestamp, same as or after start_time. A date string is also accepted.","uniqueKey":"end_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_time","typeLabel":"integer | null"},"job_location":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"job_location.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"job_location.oneOf.1","typeLabel":"null"}],"uniqueKey":"job_location","typeLabel":"string | null"},"agreement_notes":{"oneOf":[{"type":"string","uniqueKey":"agreement_notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"agreement_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"agreement_notes","typeLabel":"string | null"},"job_notes":{"oneOf":[{"type":"string","uniqueKey":"job_notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"job_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"job_notes","typeLabel":"string | null"},"is_template":{"oneOf":[{"type":"boolean","uniqueKey":"is_template.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"is_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_template","typeLabel":"boolean | null"},"asset_ids":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"asset_ids.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Array of existing asset ids.","uniqueKey":"asset_ids.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"Array of existing asset ids.","uniqueKey":"asset_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"asset_ids","typeLabel":"integer[] | null"},"settings":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"settings.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Stored as sent. No child-key rules.","uniqueKey":"settings.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Stored as sent. No child-key rules.","uniqueKey":"settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings","typeLabel":"any[] | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Tag ids, or objects {\"id\": tag id}. Type must be maintenance_agreement.","uniqueKey":"tags.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"Tag ids, or objects {\"id\": tag id}. Type must be maintenance_agreement.","uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"integer[] | null"},"assignments":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"team_id":{"type":"integer","description":"Existing team id.","isRequired":true,"uniqueKey":"assignments.oneOf.0.items.[INDEX].team_id","typeLabel":"integer"}},"required":["team_id"],"uniqueKey":"assignments.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Teams only. Each team is expanded to one assignment per member.","uniqueKey":"assignments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"team_id":{"type":"integer","description":"Existing team id."}},"required":["team_id"]},"description":"Teams only. Each team is expanded to one assignment per member.","uniqueKey":"assignments.oneOf.1","typeLabel":"null"}],"uniqueKey":"assignments","typeLabel":"object[] | null"},"location_id":{"oneOf":[{"type":"integer","description":"A location of the agreement customer. Existing location id. Prohibited when is_template is true.","uniqueKey":"location_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"A location of the agreement customer. Existing location id. Prohibited when is_template is true.","uniqueKey":"location_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"location_id","typeLabel":"integer | null"},"parent_job_id":{"oneOf":[{"type":"integer","description":"Not a template, and the agreement customer when a customer is set. Existing job id.","uniqueKey":"parent_job_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Not a template, and the agreement customer when a customer is set. Existing job id.","uniqueKey":"parent_job_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_job_id","typeLabel":"integer | null"},"services_routines":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"services_routines.items.[INDEX].title","typeLabel":"string"},"type":{"type":"string","enum":["scheduled","on-demand"],"isRequired":true,"uniqueKey":"services_routines.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"integer","description":"Omit to create. Existing service routine id.","uniqueKey":"services_routines.items.[INDEX].id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Omit to create. Existing service routine id.","uniqueKey":"services_routines.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].id","typeLabel":"integer | null"},"rrule":{"oneOf":[{"type":"string","description":"Valid rrule. Required if type is scheduled.","uniqueKey":"services_routines.items.[INDEX].rrule.oneOf.0","typeLabel":"string"},{"type":"null","description":"Valid rrule. Required if type is scheduled.","uniqueKey":"services_routines.items.[INDEX].rrule.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].rrule","typeLabel":"string | null"},"asset_ids":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"services_routines.items.[INDEX].asset_ids.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Array of existing asset ids.","uniqueKey":"services_routines.items.[INDEX].asset_ids.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"Array of existing asset ids.","uniqueKey":"services_routines.items.[INDEX].asset_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].asset_ids","typeLabel":"integer[] | null"},"schedule_generation_method":{"type":"object","properties":{"creation_method":{"oneOf":[{"type":"string","enum":["manual","automatic"],"description":"Required if schedule_generation_method is set.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.creation_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["manual","automatic"],"description":"Required if schedule_generation_method is set.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.creation_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.creation_method","typeLabel":"enum\u003cstring> | null"},"automatic_creation_method":{"type":"string","enum":["automatic","find-availability","fixed"],"description":"Required if schedule_generation_method is set.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.automatic_creation_method","typeLabel":"enum\u003cstring>"},"generation_window_in_month":{"type":"integer","enum":[1,2,3,6,12,13,18,24],"description":"Required if schedule_generation_method is set.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.generation_window_in_month","typeLabel":"enum\u003cinteger>"},"set_job_template":{"oneOf":[{"type":"boolean","description":"Must be true when automatic_creation_method is fixed.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.set_job_template.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Must be true when automatic_creation_method is fixed.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.set_job_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.set_job_template","typeLabel":"boolean | null"},"job_template_id":{"oneOf":[{"type":"integer","description":"Required if set_job_template is true. Existing job template id.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.job_template_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Required if set_job_template is true. Existing job template id.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.job_template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.job_template_id","typeLabel":"integer | null"},"fixed_method_rrule":{"oneOf":[{"type":"string","description":"Valid rrule with no start or end. Required if automatic_creation_method is fixed.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.fixed_method_rrule.oneOf.0","typeLabel":"string"},{"type":"null","description":"Valid rrule with no start or end. Required if automatic_creation_method is fixed.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.fixed_method_rrule.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.fixed_method_rrule","typeLabel":"string | null"},"scheduled_details":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.scheduled_details.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Stored as sent. No child-key rules. Required if automatic_creation_method is find-availability.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.scheduled_details.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Stored as sent. No child-key rules. Required if automatic_creation_method is find-availability.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.scheduled_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].schedule_generation_method.scheduled_details","typeLabel":"any[] | null"}},"description":"Required if type is scheduled. Prohibited, if type is on-demand.","uniqueKey":"services_routines.items.[INDEX].schedule_generation_method","typeLabel":"object"},"on_demand_generation_method":{"type":"object","properties":{"generation_window_in_month":{"type":"integer","minimum":1,"description":"Required if on_demand_generation_method is set.","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.generation_window_in_month","typeLabel":"integer"},"amount_of_services":{"type":"integer","minimum":1,"description":"Required if on_demand_generation_method is set.","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.amount_of_services","typeLabel":"integer"},"unused_services_policy":{"type":"string","enum":["expire","rollover"],"description":"Required if on_demand_generation_method is set.","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.unused_services_policy","typeLabel":"enum\u003cstring>"},"set_job_template":{"oneOf":[{"type":"boolean","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.set_job_template.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.set_job_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.set_job_template","typeLabel":"boolean | null"},"job_template_id":{"oneOf":[{"type":"integer","description":"Required if set_job_template is true. Existing job template id.","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.job_template_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Required if set_job_template is true. Existing job template id.","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.job_template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method.job_template_id","typeLabel":"integer | null"}},"description":"Required if type is on-demand. Prohibited, if type is scheduled.","uniqueKey":"services_routines.items.[INDEX].on_demand_generation_method","typeLabel":"object"},"initial_occurrence_job_id":{"oneOf":[{"type":"integer","description":"Create only. The job already booked for the first occurrence. Existing job id.","uniqueKey":"services_routines.items.[INDEX].initial_occurrence_job_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Create only. The job already booked for the first occurrence. Existing job id.","uniqueKey":"services_routines.items.[INDEX].initial_occurrence_job_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routines.items.[INDEX].initial_occurrence_job_id","typeLabel":"integer | null"}},"required":["title","type"],"uniqueKey":"services_routines.items.[INDEX]","typeLabel":"object"},"maxItems":5,"description":"Full list. An active agreement requires at least one. A scheduled routine cannot carry on_demand_generation_method. An on-demand routine cannot carry schedule_generation_method. Required if billing_routines is not set.","uniqueKey":"services_routines","typeLabel":"object[]"},"services_routine_overlaps":{"type":"array","items":{"type":"object","properties":{"first_routine_index":{"type":"integer","minimum":0,"description":"Index in services_routines.","isRequired":true,"uniqueKey":"services_routine_overlaps.items.[INDEX].first_routine_index","typeLabel":"integer"},"second_routine_index":{"type":"integer","minimum":0,"description":"A different services_routines index. The pair may appear only once.","isRequired":true,"uniqueKey":"services_routine_overlaps.items.[INDEX].second_routine_index","typeLabel":"integer"},"generation_method":{"type":"object","properties":{"automatic_creation_method":{"type":"string","enum":["automatic","find-availability","fixed"],"isRequired":true,"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.automatic_creation_method","typeLabel":"enum\u003cstring>"},"generation_window_in_month":{"type":"integer","enum":[1,2,3,6,12,13,18,24],"isRequired":true,"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.generation_window_in_month","typeLabel":"enum\u003cinteger>"},"creation_method":{"oneOf":[{"type":"string","enum":["manual","automatic"],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.creation_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["manual","automatic"],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.creation_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.creation_method","typeLabel":"enum\u003cstring> | null"},"set_job_template":{"oneOf":[{"type":"boolean","description":"Must be true when automatic_creation_method is fixed.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.set_job_template.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Must be true when automatic_creation_method is fixed.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.set_job_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.set_job_template","typeLabel":"boolean | null"},"job_template_id":{"oneOf":[{"type":"integer","description":"Required if set_job_template is true. Existing job template id.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.job_template_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Required if set_job_template is true. Existing job template id.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.job_template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.job_template_id","typeLabel":"integer | null"},"fixed_method_rrule":{"oneOf":[{"type":"string","description":"Valid rrule with no start or end. Required if automatic_creation_method is fixed.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.fixed_method_rrule.oneOf.0","typeLabel":"string"},{"type":"null","description":"Valid rrule with no start or end. Required if automatic_creation_method is fixed.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.fixed_method_rrule.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.fixed_method_rrule","typeLabel":"string | null"},"scheduled_details":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.scheduled_details.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Stored as sent. No child-key rules. Required if automatic_creation_method is find-availability.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.scheduled_details.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Stored as sent. No child-key rules. Required if automatic_creation_method is find-availability.","uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.scheduled_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method.scheduled_details","typeLabel":"any[] | null"}},"required":["automatic_creation_method","generation_window_in_month"],"isRequired":true,"uniqueKey":"services_routine_overlaps.items.[INDEX].generation_method","typeLabel":"object"},"id":{"oneOf":[{"type":"integer","description":"Existing overlap id.","uniqueKey":"services_routine_overlaps.items.[INDEX].id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Existing overlap id.","uniqueKey":"services_routine_overlaps.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"services_routine_overlaps.items.[INDEX].id","typeLabel":"integer | null"}},"required":["first_routine_index","second_routine_index","generation_method"],"uniqueKey":"services_routine_overlaps.items.[INDEX]","typeLabel":"object"},"description":"Dropped unless both indexed routines are scheduled and creation_method is automatic. One overlap per pair.","uniqueKey":"services_routine_overlaps","typeLabel":"object[]"},"communication":{"type":"array","items":{"type":"object","properties":{"send_type":{"type":"string","enum":["email","sms"],"isRequired":true,"uniqueKey":"communication.items.[INDEX].send_type","typeLabel":"enum\u003cstring>"},"target_routine_mode":{"type":"string","enum":["all","multiple","single"],"isRequired":true,"uniqueKey":"communication.items.[INDEX].target_routine_mode","typeLabel":"enum\u003cstring>"},"notify_before_date_in_days":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"communication.items.[INDEX].notify_before_date_in_days","typeLabel":"integer"},"body":{"type":"string","isRequired":true,"uniqueKey":"communication.items.[INDEX].body","typeLabel":"string"},"send_to_users":{"type":"boolean","isRequired":true,"uniqueKey":"communication.items.[INDEX].send_to_users","typeLabel":"boolean"},"send_to_customer":{"type":"boolean","isRequired":true,"uniqueKey":"communication.items.[INDEX].send_to_customer","typeLabel":"boolean"},"id":{"oneOf":[{"type":"integer","description":"Existing communication trigger id.","uniqueKey":"communication.items.[INDEX].id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Existing communication trigger id.","uniqueKey":"communication.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"communication.items.[INDEX].id","typeLabel":"integer | null"},"type":{"oneOf":[{"type":"string","enum":["reminder","renewal"],"uniqueKey":"communication.items.[INDEX].type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["reminder","renewal"],"uniqueKey":"communication.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"communication.items.[INDEX].type","typeLabel":"enum\u003cstring> | null"},"routine_indexes":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"communication.items.[INDEX].routine_indexes.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Services_routines indexes. Exactly one when target_routine_mode is single. Not checked when target_routine_mode is all. Required if target_routine_mode is single or multiple.","uniqueKey":"communication.items.[INDEX].routine_indexes.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Services_routines indexes. Exactly one when target_routine_mode is single. Not checked when target_routine_mode is all. Required if target_routine_mode is single or multiple.","uniqueKey":"communication.items.[INDEX].routine_indexes.oneOf.1","typeLabel":"null"}],"uniqueKey":"communication.items.[INDEX].routine_indexes","typeLabel":"any[] | null"},"scheduled_statuses":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"communication.items.[INDEX].scheduled_statuses.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Acceptable values draft,unscheduled,scheduled,completed,failed. Stored as a comma-separated string.","uniqueKey":"communication.items.[INDEX].scheduled_statuses.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Acceptable values draft,unscheduled,scheduled,completed,failed. Stored as a comma-separated string.","uniqueKey":"communication.items.[INDEX].scheduled_statuses.oneOf.1","typeLabel":"null"}],"uniqueKey":"communication.items.[INDEX].scheduled_statuses","typeLabel":"any[] | null"},"user_to_send":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"communication.items.[INDEX].user_to_send.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Array of existing user ids. Stored as a comma-separated string.","uniqueKey":"communication.items.[INDEX].user_to_send.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"Array of existing user ids. Stored as a comma-separated string.","uniqueKey":"communication.items.[INDEX].user_to_send.oneOf.1","typeLabel":"null"}],"uniqueKey":"communication.items.[INDEX].user_to_send","typeLabel":"integer[] | null"},"email_subject":{"oneOf":[{"type":"string","maxLength":255,"description":"Required if send_type is email.","uniqueKey":"communication.items.[INDEX].email_subject.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Required if send_type is email.","uniqueKey":"communication.items.[INDEX].email_subject.oneOf.1","typeLabel":"null"}],"uniqueKey":"communication.items.[INDEX].email_subject","typeLabel":"string | null"}},"required":["send_type","target_routine_mode","notify_before_date_in_days","body","send_to_users","send_to_customer"],"uniqueKey":"communication.items.[INDEX]","typeLabel":"object"},"description":"Full list. Triggers omitted from the payload are deleted.","uniqueKey":"communication","typeLabel":"object[]"},"billing_routines":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"billing_routines.items.[INDEX].title","typeLabel":"string"},"creation_method":{"type":"string","enum":["manual","recurring-billing"],"isRequired":true,"uniqueKey":"billing_routines.items.[INDEX].creation_method","typeLabel":"enum\u003cstring>"},"price_per_bill":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"billing_routines.items.[INDEX].price_per_bill","typeLabel":"number"},"generation_window_in_month":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"billing_routines.items.[INDEX].generation_window_in_month","typeLabel":"integer"},"id":{"oneOf":[{"type":"integer","description":"Existing billing routine id.","uniqueKey":"billing_routines.items.[INDEX].id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Existing billing routine id.","uniqueKey":"billing_routines.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_routines.items.[INDEX].id","typeLabel":"integer | null"},"rrule":{"oneOf":[{"type":"string","description":"Valid rrule. Required if creation_method is manual.","uniqueKey":"billing_routines.items.[INDEX].rrule.oneOf.0","typeLabel":"string"},{"type":"null","description":"Valid rrule. Required if creation_method is manual.","uniqueKey":"billing_routines.items.[INDEX].rrule.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_routines.items.[INDEX].rrule","typeLabel":"string | null"},"recurring_billing_id":{"oneOf":[{"type":"integer","description":"Required if creation_method is recurring-billing. Prohibited, if creation_method is manual. Existing recurring billing id.","uniqueKey":"billing_routines.items.[INDEX].recurring_billing_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Required if creation_method is recurring-billing. Prohibited, if creation_method is manual. Existing recurring billing id.","uniqueKey":"billing_routines.items.[INDEX].recurring_billing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_routines.items.[INDEX].recurring_billing_id","typeLabel":"integer | null"},"initial_occurrence_estimate_id":{"oneOf":[{"type":"integer","description":"Mutually exclusive with initial_occurrence_invoice_id. Existing estimate id.","uniqueKey":"billing_routines.items.[INDEX].initial_occurrence_estimate_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Mutually exclusive with initial_occurrence_invoice_id. Existing estimate id.","uniqueKey":"billing_routines.items.[INDEX].initial_occurrence_estimate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_routines.items.[INDEX].initial_occurrence_estimate_id","typeLabel":"integer | null"},"initial_occurrence_invoice_id":{"oneOf":[{"type":"integer","description":"Create only. Mutually exclusive with initial_occurrence_estimate_id. Existing invoice id.","uniqueKey":"billing_routines.items.[INDEX].initial_occurrence_invoice_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Create only. Mutually exclusive with initial_occurrence_estimate_id. Existing invoice id.","uniqueKey":"billing_routines.items.[INDEX].initial_occurrence_invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_routines.items.[INDEX].initial_occurrence_invoice_id","typeLabel":"integer | null"}},"required":["title","creation_method","price_per_bill","generation_window_in_month"],"uniqueKey":"billing_routines.items.[INDEX]","typeLabel":"object"},"maxItems":1,"description":"An active agreement requires exactly one.","uniqueKey":"billing_routines","typeLabel":"object[]"},"customfields":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"integer","description":"Required if field_instance_id is not set. Existing custom field instance id.","uniqueKey":"customfields.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Required if field_instance_id is not set. Existing custom field instance id.","uniqueKey":"customfields.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customfields.oneOf.0.items.[INDEX].id","typeLabel":"integer | null"},"field_instance_id":{"oneOf":[{"type":"integer","description":"Required if id is not set. Existing custom field instance id.","uniqueKey":"customfields.oneOf.0.items.[INDEX].field_instance_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Required if id is not set. Existing custom field instance id.","uniqueKey":"customfields.oneOf.0.items.[INDEX].field_instance_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customfields.oneOf.0.items.[INDEX].field_instance_id","typeLabel":"integer | null"},"value":{"oneOf":[{"type":"string","description":"Must match the custom field type when set.","uniqueKey":"customfields.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Must match the custom field type when set.","uniqueKey":"customfields.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"customfields.oneOf.0.items.[INDEX].value","typeLabel":"string | null"}},"uniqueKey":"customfields.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Array of custom fields.","uniqueKey":"customfields.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"integer","description":"Required if field_instance_id is not set. Existing custom field instance id."},{"type":"null","description":"Required if field_instance_id is not set. Existing custom field instance id."}]},"field_instance_id":{"oneOf":[{"type":"integer","description":"Required if id is not set. Existing custom field instance id."},{"type":"null","description":"Required if id is not set. Existing custom field instance id."}]},"value":{"oneOf":[{"type":"string","description":"Must match the custom field type when set."},{"type":"null","description":"Must match the custom field type when set."}]}}},"description":"Array of custom fields.","uniqueKey":"customfields.oneOf.1","typeLabel":"null"}],"uniqueKey":"customfields","typeLabel":"object[] | null"},"template_id":{"oneOf":[{"type":"integer","description":"Existing maintenance agreement template id.","uniqueKey":"template_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Existing maintenance agreement template id.","uniqueKey":"template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"template_id","typeLabel":"integer | null"},"engage_call_to_records":{"type":"array","items":{"type":"object","properties":{"engage_call_id":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"engage_call_to_records.items.[INDEX].engage_call_id","typeLabel":"string"},"is_primary_call":{"oneOf":[{"type":"boolean","uniqueKey":"engage_call_to_records.items.[INDEX].is_primary_call.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"engage_call_to_records.items.[INDEX].is_primary_call.oneOf.1","typeLabel":"null"}],"uniqueKey":"engage_call_to_records.items.[INDEX].is_primary_call","typeLabel":"boolean | null"},"lead_source_id":{"oneOf":[{"type":"integer","description":"Existing lead source id.","uniqueKey":"engage_call_to_records.items.[INDEX].lead_source_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Existing lead source id.","uniqueKey":"engage_call_to_records.items.[INDEX].lead_source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"engage_call_to_records.items.[INDEX].lead_source_id","typeLabel":"integer | null"}},"required":["engage_call_id"],"uniqueKey":"engage_call_to_records.items.[INDEX]","typeLabel":"object"},"description":"Create only. At most one item may be the primary call.","uniqueKey":"engage_call_to_records","typeLabel":"object[]"}},"required":["title","status_id"],"uniqueKey":"","typeLabel":"object"},"example":{"customer_id":1,"title":"some string","status_id":1,"status_workflow_id":1,"customer_contact_id":1,"parent_invoice_id":1,"timezone":"some string","start_time":1,"end_time":1,"job_location":"some string","agreement_notes":"some string","job_notes":"some string","is_template":true,"asset_ids":[1],"settings":[],"tags":[1],"assignments":[{"team_id":1}],"location_id":1,"parent_job_id":1,"services_routines":[{"id":1,"title":"some string","rrule":"some string","type":"scheduled","asset_ids":[1],"schedule_generation_method":{"creation_method":"manual","automatic_creation_method":"automatic","generation_window_in_month":1,"set_job_template":true,"job_template_id":1,"fixed_method_rrule":"some string","scheduled_details":[]},"on_demand_generation_method":{"generation_window_in_month":1,"amount_of_services":1,"unused_services_policy":"expire","set_job_template":true,"job_template_id":1},"initial_occurrence_job_id":1}],"services_routine_overlaps":[{"id":1,"first_routine_index":1,"second_routine_index":1,"generation_method":{"creation_method":"manual","automatic_creation_method":"automatic","generation_window_in_month":1,"set_job_template":true,"job_template_id":1,"fixed_method_rrule":"some string","scheduled_details":[]}}],"communication":[{"id":1,"send_type":"email","target_routine_mode":"all","type":"reminder","routine_indexes":[],"notify_before_date_in_days":1,"scheduled_statuses":[],"user_to_send":[1],"email_subject":"some string","body":"some string","send_to_users":true,"send_to_customer":true}],"billing_routines":[{"id":1,"title":"some string","creation_method":"manual","rrule":"some string","recurring_billing_id":1,"price_per_bill":1,"generation_window_in_month":1,"initial_occurrence_estimate_id":1,"initial_occurrence_invoice_id":1}],"customfields":[{"id":1,"field_instance_id":1,"value":"some string"}],"template_id":1,"engage_call_to_records":[{"engage_call_id":"some string","is_primary_call":true,"lead_source_id":1}]},"examples":{"Example":{"title":"Example","value":{"customer_id":1,"title":"some string","status_id":1,"status_workflow_id":1,"customer_contact_id":1,"parent_invoice_id":1,"timezone":"some string","start_time":1,"end_time":1,"job_location":"some string","agreement_notes":"some string","job_notes":"some string","is_template":true,"asset_ids":[1],"settings":[],"tags":[1],"assignments":[{"team_id":1}],"location_id":1,"parent_job_id":1,"services_routines":[{"id":1,"title":"some string","rrule":"some string","type":"scheduled","asset_ids":[1],"schedule_generation_method":{"creation_method":"manual","automatic_creation_method":"automatic","generation_window_in_month":1,"set_job_template":true,"job_template_id":1,"fixed_method_rrule":"some string","scheduled_details":[]},"on_demand_generation_method":{"generation_window_in_month":1,"amount_of_services":1,"unused_services_policy":"expire","set_job_template":true,"job_template_id":1},"initial_occurrence_job_id":1}],"services_routine_overlaps":[{"id":1,"first_routine_index":1,"second_routine_index":1,"generation_method":{"creation_method":"manual","automatic_creation_method":"automatic","generation_window_in_month":1,"set_job_template":true,"job_template_id":1,"fixed_method_rrule":"some string","scheduled_details":[]}}],"communication":[{"id":1,"send_type":"email","target_routine_mode":"all","type":"reminder","routine_indexes":[],"notify_before_date_in_days":1,"scheduled_statuses":[],"user_to_send":[1],"email_subject":"some string","body":"some string","send_to_users":true,"send_to_customer":true}],"billing_routines":[{"id":1,"title":"some string","creation_method":"manual","rrule":"some string","recurring_billing_id":1,"price_per_bill":1,"generation_window_in_month":1,"initial_occurrence_estimate_id":1,"initial_occurrence_invoice_id":1}],"customfields":[{"id":1,"field_instance_id":1,"value":"some string"}],"template_id":1,"engage_call_to_records":[{"engage_call_id":"some string","is_primary_call":true,"lead_source_id":1}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"31a2fb79-7e94-48d7-9bb7-5cff9106bfb4":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","description":"false when the request succeeds.","example":false,"uniqueKey":"error","typeLabel":"boolean"},"response":{"type":"object","uniqueKey":"response","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":true,"errors":["error message","error message"]},"examples":{"Example":{"title":"Example","value":{"error":true,"errors":["error message","error message"]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"24e9ebec-eb55-4aad-ad91-7d676e582d36":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"27e25b33-33a0-4c47-8f43-0a517e5eb563":{"url":"https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"openapi/fieldpulse-api.json"},"subdomain":"fieldpulse","siteName":"FieldPulse Help Center","title":"Create Maintenance Agreement - FieldPulse Help Center","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6afffc17e9496cad8bab4f9c","deploymentId":"69a099be6ec314fbab662e4e","questionText":"How do I assign teams?","status":"active","generatedBy":"contextual","path":"api-reference/maintenance-agreements/create-maintenance-agreement","createdAt":"2026-11-20T07:51:51.279Z","updatedAt":"2026-11-20T07:51:51.279Z","__v":0},{"_id":"6afffc17e9496cad8bab4f9d","deploymentId":"69a099be6ec314fbab662e4e","questionText":"Can I create a template?","status":"active","generatedBy":"contextual","path":"api-reference/maintenance-agreements/create-maintenance-agreement","createdAt":"2026-11-20T07:51:51.279Z","updatedAt":"2026-11-20T07:51:51.279Z","__v":0},{"_id":"6afffc17e9496cad8bab4f9b","deploymentId":"69a099be6ec314fbab662e4e","questionText":"What fields are required?","status":"active","generatedBy":"contextual","path":"api-reference/maintenance-agreements/create-maintenance-agreement","createdAt":"2026-11-20T07:51:51.279Z","updatedAt":"2026-11-20T07:51:51.279Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/maintenance-agreements/create-maintenance-agreement","matchLevel":0},"es":{"href":"/es","matchLevel":3}},"searchTabScopes":[{"language":"en","tab":"Home"},{"language":"en","tab":"What's New"},{"language":"en","tab":"API Reference"}]},"lastModified":"2026-11-20T07:51:24.538Z","originalFileLocation":"api-reference/maintenance-agreements/create-maintenance-agreement.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"FieldPulse Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Maintenance Agreement - FieldPulse Help Center\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FieldPulse Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fieldpulse.mintlify.site/_mintlify/api/og/v2?division=Maintenance+Agreements\u0026amp;title=Create+Maintenance+Agreement\u0026amp;theme=d2b8fb14ee6e95c44bc5b75e\u0026amp;signature=2cc118a32b93573f5b2c04c083ce4898f6cd8aadabd51e934cd7ead055e11587\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Maintenance Agreement - FieldPulse Help Center\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fieldpulse.mintlify.site/_mintlify/api/og/v2?division=Maintenance+Agreements\u0026amp;title=Create+Maintenance+Agreement\u0026amp;theme=d2b8fb14ee6e95c44bc5b75e\u0026amp;signature=2cc118a32b93573f5b2c04c083ce4898f6cd8aadabd51e934cd7ead055e11587\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fieldpulse/E8g1gXYMW9mIy6FP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FieldPulse Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00034D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/maintenance-agreements/create-maintenance-agreement.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.fieldpulse.com/#organization\",\"name\":\"FieldPulse\",\"url\":\"https://www.fieldpulse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://help.fieldpulse.com/static/logo/fieldpulse-organization-logo.png\"},\"sameAs\":[\"https://www.linkedin.com/company/fieldpulse/\",\"https://www.youtube.com/@Fieldpulse\",\"https://www.facebook.com/fieldpulse/\",\"https://www.instagram.com/fieldpulse/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://help.fieldpulse.com#website\",\"name\":\"FieldPulse Help Center\",\"url\":\"https://help.fieldpulse.com\",\"publisher\":{\"@id\":\"https://www.fieldpulse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement#webpage\",\"url\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement\",\"name\":\"Create Maintenance Agreement\",\"dateModified\":\"2026-11-20T07:51:24.538Z\",\"isPartOf\":{\"@id\":\"https://help.fieldpulse.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Maintenance Agreements\",\"item\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/get-maintenance-agreements\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Maintenance Agreement\",\"item\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement#apireference\",\"headline\":\"Create Maintenance Agreement\",\"name\":\"Create Maintenance Agreement\",\"url\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement\",\"mainEntityOfPage\":{\"@id\":\"https://help.fieldpulse.com/api-reference/maintenance-agreements/create-maintenance-agreement#webpage\"},\"dateModified\":\"2026-11-20T07:51:24.538Z\",\"publisher\":{\"@id\":\"https://www.fieldpulse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.fieldpulse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FieldPulse Help Center\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FieldPulse\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/maintenance-agreements/create-maintenance-agreement.md","siteName":"FieldPulse Help Center","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/changelog"}]},{"tab":"API Reference","groups":[{"group":"Get Started","pages":[{"title":"Overview","href":"/api-reference/overview"},{"title":"Getting Started","href":"/api-reference/getting-started"},{"title":"Webhooks","href":"/api-reference/webhooks"},{"title":"Glossary","href":"/api-reference/glossary"}]},{"group":"Assets","boost":0.1,"pages":[{"openapi":"get /assets","title":"Retrieve assets list","href":"/api-reference/assets/retrieve-assets-list"},{"openapi":"post /assets","title":"Create an asset","href":"/api-reference/assets/create-an-asset"},{"openapi":"get /assets/{id}","title":"Retrieve asset by ID","href":"/api-reference/assets/retrieve-asset-by-id"},{"openapi":"put /assets/{id}","title":"Update asset by ID","href":"/api-reference/assets/update-asset-by-id"},{"openapi":"delete /assets/{id}","title":"Delete asset by ID","href":"/api-reference/assets/delete-asset-by-id"}]},{"group":"Assets Category","boost":0.1,"pages":[{"openapi":"get /assets-category","title":"Retrieve asset categories list","href":"/api-reference/assets-category/retrieve-asset-categories-list"},{"openapi":"post /assets-category","title":"Create an asset category","href":"/api-reference/assets-category/create-an-asset-category"},{"openapi":"get /assets-category/{id}","title":"Retrieve asset category by ID","href":"/api-reference/assets-category/retrieve-asset-category-by-id"},{"openapi":"put /assets-category/{id}","title":"Update asset category by ID","href":"/api-reference/assets-category/update-asset-category-by-id"},{"openapi":"delete /assets-category/{id}","title":"Delete asset category by ID","href":"/api-reference/assets-category/delete-asset-category-by-id"}]},{"group":"Comments","boost":0.1,"pages":[{"openapi":"get /comments","title":"Retrieve comments list","href":"/api-reference/comments/retrieve-comments-list"},{"openapi":"post /comments","title":"Create a comment","href":"/api-reference/comments/create-a-comment"},{"openapi":"get /comments/{id}","title":"Retrieve comment by ID","href":"/api-reference/comments/retrieve-comment-by-id"},{"openapi":"put /comments/{id}","title":"Update comment by ID","href":"/api-reference/comments/update-comment-by-id"},{"openapi":"delete /comments/{id}","title":"Delete comment by ID","href":"/api-reference/comments/delete-comment-by-id"}]},{"group":"Company Profile","boost":0.1,"pages":[{"openapi":"get /company-profile","title":"Retrieve company profiles list","href":"/api-reference/company-profile/retrieve-company-profiles-list"},{"openapi":"get /company-profile/{id}","title":"Retrieve company profile by ID","href":"/api-reference/company-profile/retrieve-company-profile-by-id"}]},{"group":"Contracts","boost":0.1,"pages":[{"openapi":"get /contracts","title":"Retrieve contracts list","href":"/api-reference/contracts/retrieve-contracts-list"},{"openapi":"get /contracts/{id}","title":"Retrieve contract by ID","href":"/api-reference/contracts/retrieve-contract-by-id"}]},{"group":"Customers","boost":0.1,"pages":[{"openapi":"get /customers","title":"Retrieve customers list","href":"/api-reference/customers/retrieve-customers-list"},{"openapi":"post /customers","title":"Create a customer","href":"/api-reference/customers/create-a-customer"},{"openapi":"get /customers/{customerId}","title":"Retrieve customer by ID","href":"/api-reference/customers/retrieve-customer-by-id"},{"openapi":"put /customers/{customerId}","title":"Update customer by ID","href":"/api-reference/customers/update-customer-by-id"},{"openapi":"delete /customers/{customerId}","title":"Delete customer by ID","href":"/api-reference/customers/delete-customer-by-id"},{"openapi":"get /customers/{customerId}/customer-contact","title":"Retrieve customer contacts list","href":"/api-reference/customers/retrieve-customer-contacts-list"},{"openapi":"post /customers/{customerId}/customer-contact","title":"Create a customer contact","href":"/api-reference/customers/create-a-customer-contact"},{"openapi":"get /customers/{customerId}/customer-contact/{contactId}","title":"Retrieve customer contact by ID","href":"/api-reference/customers/retrieve-customer-contact-by-id"},{"openapi":"put /customers/{customerId}/customer-contact/{contactId}","title":"Update customer contact by ID","href":"/api-reference/customers/update-customer-contact-by-id"},{"openapi":"delete /customers/{customerId}/customer-contact/{contactId}","title":"Delete customer contact by ID","href":"/api-reference/customers/delete-customer-contact-by-id"}]},{"group":"Custom Fields","boost":0.1,"pages":[{"openapi":"get /custom-fields","title":"Retrieve custom fields list","href":"/api-reference/custom-fields/retrieve-custom-fields-list"},{"openapi":"post /custom-fields","title":"Create a custom field","href":"/api-reference/custom-fields/create-a-custom-field"},{"openapi":"get /custom-fields/{customfieldId}","title":"Retrieve a custom field by ID","href":"/api-reference/custom-fields/retrieve-a-custom-field-by-id"},{"openapi":"put /custom-fields/{customfieldId}","title":"Update custom field by ID","href":"/api-reference/custom-fields/update-custom-field-by-id"},{"openapi":"delete /custom-fields/{customfieldId}","title":"Delete custom field by ID","href":"/api-reference/custom-fields/delete-custom-field-by-id"}]},{"group":"Estimates","boost":0.1,"pages":[{"openapi":"get /estimates","title":"Retrieve estimates list","href":"/api-reference/estimates/retrieve-estimates-list"},{"openapi":"post /estimates","title":"Create an estimate","href":"/api-reference/estimates/create-an-estimate"},{"openapi":"get /estimates/{estimateId}","title":"Retrieve estimate by ID","href":"/api-reference/estimates/retrieve-estimate-by-id"},{"openapi":"put /estimates/{estimateId}","title":"Update estimate by ID","href":"/api-reference/estimates/update-estimate-by-id"},{"openapi":"delete /estimates/{estimateId}","title":"Delete estimate by ID","href":"/api-reference/estimates/delete-estimate-by-id"},{"openapi":"get /estimates/qb-classes","title":"Get Estimate QB Classes","href":"/api-reference/estimates/get-estimate-qb-classes"},{"openapi":"get /estimates/status-workflows","title":"Retrieve estimate status workflows","href":"/api-reference/estimates/retrieve-estimate-status-workflows"},{"openapi":"get /estimates/status-workflow-statuses","title":"Retrieve estimate statuses","href":"/api-reference/estimates/retrieve-estimate-statuses"}]},{"group":"Invoices","boost":0.1,"pages":[{"openapi":"get /invoices","title":"List invoices","href":"/api-reference/invoices/list-invoices"},{"openapi":"post /invoices","title":"Create an invoice","href":"/api-reference/invoices/create-an-invoice"},{"openapi":"get /invoices/{invoiceId}","title":"Retrieve invoice by ID","href":"/api-reference/invoices/retrieve-invoice-by-id"},{"openapi":"put /invoices/{invoiceId}","title":"Update invoice by ID","href":"/api-reference/invoices/update-invoice-by-id"},{"openapi":"delete /invoices/{invoiceId}","title":"Delete invoice by ID","href":"/api-reference/invoices/delete-invoice-by-id"},{"openapi":"put /invoices/{invoiceId}/price-update","title":"Update Invoice Prices","href":"/api-reference/invoices/update-invoice-prices"},{"openapi":"get /invoices/qb-classes","title":"Get Invoice QB Classes","href":"/api-reference/invoices/get-invoice-qb-classes"},{"openapi":"get /invoices/status-workflows","title":"Retrieve invoice status workflows","href":"/api-reference/invoices/retrieve-invoice-status-workflows"},{"openapi":"get /invoices/status-workflow-statuses","title":"Retrieve invoice statuses","href":"/api-reference/invoices/retrieve-invoice-statuses"}]},{"group":"Items","boost":0.1,"pages":[{"openapi":"get /items","title":"Retrieve items list","href":"/api-reference/items/retrieve-items-list"},{"openapi":"post /items","title":"Create item","href":"/api-reference/items/create-item"},{"openapi":"get /items/{id}","title":"Retrieve item by ID","href":"/api-reference/items/retrieve-item-by-id"},{"openapi":"put /items/{id}","title":"Update by Id","href":"/api-reference/items/update-by-id"}]},{"group":"Jobs","boost":0.1,"pages":[{"openapi":"get /jobs","title":"Retrieve jobs list","href":"/api-reference/jobs/retrieve-jobs-list"},{"openapi":"post /jobs","title":"Create a job","href":"/api-reference/jobs/create-a-job"},{"openapi":"get /jobs/{jobId}","title":"Retrieve job by ID","href":"/api-reference/jobs/retrieve-job-by-id"},{"openapi":"put /jobs/{jobId}","title":"Update job by ID","href":"/api-reference/jobs/update-job-by-id"},{"openapi":"delete /jobs/{jobId}","title":"Delete job by ID","href":"/api-reference/jobs/delete-job-by-id"},{"openapi":"get /jobs/status-workflows","title":"Retrieve job status workflows list","href":"/api-reference/jobs/retrieve-job-status-workflows-list"},{"openapi":"get /jobs/status-workflow-statuses","title":"Retrieve job status workflow statuses list","href":"/api-reference/jobs/retrieve-job-status-workflow-statuses-list"},{"openapi":"get /jobs/qb-classes","title":"Get Job QB Classes","href":"/api-reference/jobs/get-job-qb-classes"}]},{"group":"Lead Source","boost":0.1,"pages":[{"openapi":"get /lead-source","title":"Retrieve lead sources list","href":"/api-reference/lead-source/retrieve-lead-sources-list"}]},{"group":"Locations","boost":0.1,"pages":[{"openapi":"get /locations","title":"Retrieve locations list","href":"/api-reference/locations/retrieve-locations-list"},{"openapi":"post /locations","title":"Create a location","href":"/api-reference/locations/create-a-location"},{"openapi":"get /locations/{locationId}","title":"Retrieve location by ID","href":"/api-reference/locations/retrieve-location-by-id"},{"openapi":"put /locations/{locationId}","title":"Update location by ID","href":"/api-reference/locations/update-location-by-id"},{"openapi":"delete /locations/{locationId}","title":"Delete location by ID","href":"/api-reference/locations/delete-location-by-id"}]},{"group":"Maintenance Agreements","boost":0.1,"pages":[{"openapi":"get /maintenance-agreements","title":"Get Maintenance Agreements","description":null,"href":"/api-reference/maintenance-agreements/get-maintenance-agreements"},{"openapi":"post /maintenance-agreements","title":"Create Maintenance Agreement","href":"/api-reference/maintenance-agreements/create-maintenance-agreement"},{"openapi":"get /maintenance-agreements/{id}","title":"Get Maintenance Agreement by ID","description":null,"href":"/api-reference/maintenance-agreements/get-maintenance-agreement-by-id"},{"openapi":"put /maintenance-agreements/{id}","title":"Update Maintenance Agreement by ID","href":"/api-reference/maintenance-agreements/update-maintenance-agreement-by-id"},{"openapi":"delete /maintenance-agreements/{id}","title":"Delete Maintenance Agreement by ID","href":"/api-reference/maintenance-agreements/delete-maintenance-agreement-by-id"},{"openapi":"post /maintenance-agreements/billing-connect","title":"Connect Billing Occurrence","href":"/api-reference/maintenance-agreements/connect-billing-occurrence"},{"openapi":"post /maintenance-agreements/billing-disconnect","title":"Disconnect Billing Occurrence","href":"/api-reference/maintenance-agreements/disconnect-billing-occurrence"},{"openapi":"post /maintenance-agreements/service-connect","title":"Connect Service Occurrence","href":"/api-reference/maintenance-agreements/connect-service-occurrence"},{"openapi":"post /maintenance-agreements/service-disconnect","title":"Disconnect Service Occurrence","href":"/api-reference/maintenance-agreements/disconnect-service-occurrence"},{"openapi":"delete /maintenance-agreements/service-routine/{id}","title":"Delete Maintenance Agreement Service Routine","href":"/api-reference/maintenance-agreements/delete-maintenance-agreement-service-routine"}]},{"group":"Material Lists","boost":0.1,"pages":[{"openapi":"get /material-lists","title":"Get list of Material Lists","href":"/api-reference/material-lists/get-list-of-material-lists"},{"openapi":"post /material-list","title":"Create Material List","href":"/api-reference/material-lists/create-material-list"},{"openapi":"get /material-list/{id}","title":"Get Material List by ID","href":"/api-reference/material-lists/get-material-list-by-id"},{"openapi":"put /material-list/{id}","title":"Update Material List by ID","href":"/api-reference/material-lists/update-material-list-by-id"},{"openapi":"delete /material-list/{id}","title":"Delete Material List by ID","href":"/api-reference/material-lists/delete-material-list-by-id"},{"openapi":"post /material-lists/{id}/connect","title":"Connect Material List to entity","href":"/api-reference/material-lists/connect-material-list-to-entity"},{"openapi":"post /material-lists/{id}/disconnect","title":"Disconnect Material List from entity","href":"/api-reference/material-lists/disconnect-material-list-from-entity"},{"openapi":"post /material-lists/{id}/item-connect","title":"Connect Material List item to entity","href":"/api-reference/material-lists/connect-material-list-item-to-entity"}]},{"group":"Payments","boost":0.1,"pages":[{"openapi":"get /payments","title":"Retrieve payments list","href":"/api-reference/payments/retrieve-payments-list"},{"openapi":"post /payments","title":"Create a payment","href":"/api-reference/payments/create-a-payment"},{"openapi":"get /payments/{id}","title":"Retrieve payment by ID","href":"/api-reference/payments/retrieve-payment-by-id"},{"openapi":"put /payments/{id}","title":"Update payment by ID","href":"/api-reference/payments/update-payment-by-id"},{"openapi":"delete /payments/{id}","title":"Delete payment by ID","href":"/api-reference/payments/delete-payment-by-id"}]},{"group":"Pipeline Status","boost":0.1,"pages":[{"openapi":"get /pipeline-status","title":"Retrieve pipeline statuses list","href":"/api-reference/pipeline-status/retrieve-pipeline-statuses-list"}]},{"group":"Projects","boost":0.1,"pages":[{"openapi":"get /projects","title":"Retrieve projects list","href":"/api-reference/projects/retrieve-projects-list"},{"openapi":"post /projects","title":"Create a project","href":"/api-reference/projects/create-a-project"},{"openapi":"get /projects/{projectId}","title":"Retrieve project by ID","href":"/api-reference/projects/retrieve-project-by-id"},{"openapi":"put /projects/{projectId}","title":"Update project by ID","href":"/api-reference/projects/update-project-by-id"},{"openapi":"delete /projects/{projectId}","title":"Delete project by ID","href":"/api-reference/projects/delete-project-by-id"}]},{"group":"Purchase Orders","boost":0.1,"pages":[{"openapi":"get /purchase-orders","title":"Retrieve purchase orders list","href":"/api-reference/purchase-orders/retrieve-purchase-orders-list"},{"openapi":"post /purchase-orders","title":"Create a puchase order","href":"/api-reference/purchase-orders/create-a-puchase-order"},{"openapi":"get /purchase-orders/{id}","title":"Retrieve purchase order by ID","href":"/api-reference/purchase-orders/retrieve-purchase-order-by-id"},{"openapi":"put /purchase-orders/{id}","title":"Update puchase order by ID","href":"/api-reference/purchase-orders/update-puchase-order-by-id"},{"openapi":"delete /purchase-orders/{id}","title":"Delete purchase order by ID","href":"/api-reference/purchase-orders/delete-purchase-order-by-id"}]},{"group":"Subtasks","boost":0.1,"pages":[{"openapi":"get /subtasks","title":"Retrieve subtasks list","href":"/api-reference/subtasks/retrieve-subtasks-list"},{"openapi":"post /subtasks","title":"Create a subtask","href":"/api-reference/subtasks/create-a-subtask"},{"openapi":"get /subtasks/{id}","title":"Retrieve subtask by ID","href":"/api-reference/subtasks/retrieve-subtask-by-id"},{"openapi":"put /subtasks/{id}","title":"Update subtask by ID","href":"/api-reference/subtasks/update-subtask-by-id"},{"openapi":"delete /subtasks/{id}","title":"Delete subtask by ID","href":"/api-reference/subtasks/delete-subtask-by-id"}]},{"group":"Tags","boost":0.1,"pages":[{"openapi":"get /tags","title":"Retrieve tags list","href":"/api-reference/tags/retrieve-tags-list"},{"openapi":"post /tags","title":"Create a tag","href":"/api-reference/tags/create-a-tag"},{"openapi":"get /tags/{tagId}","title":"Retrieve tag by ID","href":"/api-reference/tags/retrieve-tag-by-id"},{"openapi":"put /tags/{tagId}","title":"Update tag by ID","href":"/api-reference/tags/update-tag-by-id"},{"openapi":"delete /tags/{tagId}","title":"Delete tag by ID","href":"/api-reference/tags/delete-tag-by-id"}]},{"group":"Teams","boost":0.1,"pages":[{"openapi":"get /teams","title":"Retrieve company teams list","href":"/api-reference/teams/retrieve-company-teams-list"}]},{"group":"Timesheets","boost":0.1,"pages":[{"openapi":"get /timesheets","title":"Retrieve timesheets list","href":"/api-reference/timesheets/retrieve-timesheets-list"},{"openapi":"post /timesheets","title":"Create a timesheet","href":"/api-reference/timesheets/create-a-timesheet"},{"openapi":"get /timesheets/{id}","title":"Retrieve timesheet by ID","href":"/api-reference/timesheets/retrieve-timesheet-by-id"},{"openapi":"put /timesheets/{id}","title":"Update timesheet by ID","href":"/api-reference/timesheets/update-timesheet-by-id"},{"openapi":"delete /timesheets/{id}","title":"Delete timesheet by ID","href":"/api-reference/timesheets/delete-timesheet-by-id"}]},{"group":"Users","boost":0.1,"pages":[{"openapi":"get /users","title":"Retrieve users list","href":"/api-reference/users/retrieve-users-list"}]},{"group":"Vendors","boost":0.1,"pages":[{"openapi":"get /vendors","title":"Retrieve vendors list","href":"/api-reference/vendors/retrieve-vendors-list"},{"openapi":"get /vendors/{id}","title":"Retrieve vendor by ID","href":"/api-reference/vendors/retrieve-vendor-by-id"}]},{"group":"Version","boost":0.1,"pages":[{"openapi":"get /version","title":"Get version","href":"/api-reference/version/get-version"}]}]}]},{"language":"es","banner":{"content":"Algunas páginas aún están solo en inglés. [Ver el centro de ayuda en inglés](/).","dismissible":true},"footer":{"socials":{"facebook":"https://www.facebook.com/fieldpulse","youtube":"https://www.youtube.com/@FieldPulse","linkedin":"https://www.linkedin.com/company/fieldpulse","instagram":"https://www.instagram.com/fieldpulse"},"links":[{"header":"Funciones","items":[{"label":"Programación y despacho","href":"https://www.fieldpulse.com/features/scheduling-and-dispatching"},{"label":"Presupuestos y facturas","href":"https://www.fieldpulse.com/features/estimates-and-invoices"},{"label":"Administración de clientes","href":"https://www.fieldpulse.com/features/customer-management"},{"label":"Administración de trabajos","href":"https://www.fieldpulse.com/features/job-management"},{"label":"Catálogo de precios","href":"https://www.fieldpulse.com/features/pricebook"},{"label":"Administración de inventario","href":"https://www.fieldpulse.com/features/inventory-management"}]},{"header":"Producto","items":[{"label":"Descripción general del producto","href":"https://www.fieldpulse.com/features"},{"label":"Precios","href":"https://www.fieldpulse.com/pricing"},{"label":"ClearPath","href":"https://www.fieldpulse.com/features/clearpath"},{"label":"Field Intelligence","href":"https://www.fieldpulse.com/features/field-intelligence"}]},{"header":"Empresa","items":[{"label":"Nuestra misión","href":"https://www.fieldpulse.com/company"},{"label":"Socios","href":"https://www.fieldpulse.com/company/partners"},{"label":"Empleos","href":"https://www.fieldpulse.com/company/careers"},{"label":"Contacto","href":"https://www.fieldpulse.com/company/contact-us"}]},{"header":"Recursos","items":[{"label":"Centro de ayuda","href":"https://help.fieldpulse.com"},{"label":"Casos de éxito","href":"https://www.fieldpulse.com/resources/customer-stories"},{"label":"Blog","href":"https://www.fieldpulse.com/resources/blog"},{"label":"Preguntas frecuentes","href":"https://www.fieldpulse.com/resources/faq"}]}]},"navbar":{"links":[{"href":"/es/changelog","label":"Novedades"},{"href":"/api-reference/overview","label":"Referencia de la API (en inglés)"},{"href":"/","label":"Ver en inglés"},{"href":"https://webapp.fieldpulse.com","label":"Iniciar sesión"}]},"pages":[{"title":"es","href":"/es"}]}]},"basePath":"","title":"Create Maintenance Agreement - FieldPulse Help Center","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","2bfc744e19","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","NarrationPlayer-C_GXa7WA.js","types-CiTgMxws.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}