> ## Documentation Index > Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt > Use this file to discover all available pages before exploring further. # Sync A Partner ## OpenAPI ````yaml /openapi.json post /v1/partners/{partner_id}/sync openapi: 3.0.3 info: contact: name: Stuut Support url: https://stuut.ai email: devs@stuut.co termsOfService: https://stuut.ai/terms-and-conditions title: Stuut API version: 0.1.0 servers: - url: http://api.stuut.ai security: [] tags: - name: Analytics - name: Bank Accounts - name: Bank Statements - name: Bank Transactions - name: Call Agents - name: Call Agent Scenarios - name: Calls - name: Contact Suggestions - name: demo - name: Email Senders - name: Email Templates - name: Email Template Folders - name: Email Threads - name: Emails - name: Files - name: Invoices - name: Notes - name: Organizations - name: Outreach Workflows - name: Partners - name: Partner Contacts - name: Payments - name: Phone Numbers - name: Plaid - name: Profile - name: Pusher - name: Remittances - name: Tags - name: Tasks - name: User Invites - name: Users paths: /v1/partners/{partner_id}/sync: post: tags: - Partners summary: Sync A Partner operationId: partner.sync parameters: - in: path name: partner_id schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Partner' description: Successful response '401': content: application/json: schema: $ref: '#/components/schemas/StuutErrorHTTP' description: Authentication error '404': content: application/json: schema: $ref: '#/components/schemas/StuutErrorHTTP' description: Not found security: - BearerAuth: [] components: schemas: Partner: type: object properties: id: type: string maxLength: 32 account_number: type: string description: The customer's account number. nullable: true ap_portals: type: array items: $ref: '#/components/schemas/APPortal' assignee: $ref: '#/components/schemas/User' assignee_id: type: string maxLength: 32 nullable: true avg_days_past_due: type: number billing_address: $ref: '#/components/schemas/Address' billing_address_id: type: integer nullable: true contacts: type: array items: $ref: '#/components/schemas/Contact' created_at: type: string format: date-time currency: type: string enum: - ADP - AED - AFA - AFN - ALK - ALL - AMD - ANG - AOA - AOK - AON - AOR - ARA - ARL - ARM - ARP - ARS - ATS - AUD - AWG - AZM - AZN - BAD - BAM - BAN - BBD - BDT - BEC - BEF - BEL - BGL - BGM - BGN - BGO - BHD - BIF - BMD - BND - BOB - BOL - BOP - BOV - BRB - BRC - BRE - BRL - BRN - BRR - BRZ - BSD - BTN - BUK - BWP - BYB - BYN - BYR - BZD - CAD - CDF - CHE - CHF - CHW - CLE - CLF - CLP - CNH - CNX - CNY - COP - COU - CRC - CSD - CSK - CUC - CUP - CVE - CYP - CZK - DDM - DEM - DJF - DKK - DOP - DZD - ECS - ECV - EEK - EGP - ERN - ESA - ESB - ESP - ETB - EUR - FIM - FJD - FKP - FRF - GBP - GEK - GEL - GHC - GHS - GIP - GMD - GNF - GNS - GQE - GRD - GTQ - GWE - GWP - GYD - HKD - HNL - HRD - HRK - HTG - HUF - IDR - IEP - ILP - ILR - ILS - INR - IQD - IRR - ISJ - ISK - ITL - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRH - KRO - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LTT - LUC - LUF - LUL - LVL - LVR - LYD - MAD - MAF - MCF - MDC - MDL - MGA - MGF - MKD - MKN - MLF - MMK - MNT - MOP - MRO - MRU - MTL - MTP - MUR - MVP - MVR - MWK - MXN - MXP - MXV - MYR - MZE - MZM - MZN - NAD - NGN - NIC - NIO - NLG - NOK - NPR - NZD - OMR - PAB - PEI - PEN - PES - PGK - PHP - PKR - PLN - PLZ - PTE - PYG - QAR - RHD - ROL - RON - RSD - RUB - RUR - RWF - SAR - SBD - SCR - SDD - SDG - SDP - SEK - SGD - SHP - SIT - SKK - SLE - SLL - SOS - SRD - SRG - SSP - STD - STN - SUR - SVC - SYP - SZL - THB - TJR - TJS - TMM - TMT - TND - TOP - TPE - TRL - TRY - TTD - TWD - TZS - UAH - UAK - UGS - UGX - USD - USN - USS - UYI - UYP - UYU - UYW - UZS - VEB - VED - VEF - VES - VND - VNN - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XCG - XDR - XEU - XFO - XFU - XOF - XPD - XPF - XPT - XRE - XSU - XTS - XUA - XXX - YDD - YER - YUD - YUM - YUN - YUR - ZAL - ZAR - ZMK - ZMW - ZRN - ZRZ - ZWD - ZWL - ZWR - null maxLength: 3 description: The partner's default currency code (e.g. USD). nullable: true custom_fields: {} description: type: string description: A description of the partner. nullable: true email: type: string maxLength: 255 description: The partner's company email address. nullable: true family_name: type: string description: The partner's family name. nullable: true finix_identity_id: type: string nullable: true given_name: type: string description: The partner's given name. nullable: true invoice_balance: type: number invoice_prefix: type: string description: The prefix for this partner's invoice numbers. nullable: true is_active: type: boolean description: Whether the partner is active. is_call_outreach_manually_paused: type: boolean is_company: type: boolean description: Whether the partner is a company or individual. is_contact_enrichment_enabled: type: boolean is_email_disabled: type: boolean description: Whether the partner's email address is no longer valid. is_email_outreach_manually_paused: type: boolean is_phone_disabled: type: boolean description: Whether the partner's email address is no longer valid. is_primary_email: type: boolean description: Whether the partner's email is the primary email contact. is_primary_phone: type: boolean description: Whether the partner's phone number is the primary phone contact. last_inbound_at: type: string format: date-time last_outreach_at: type: string format: date-time description: The last date outreach was sent for this partner. nullable: true last_outreach_channel: maxLength: 5 description: >- The last channel outreach was sent in for this partner (phone or email). enum: - email - call - null nullable: true last_outreach_to: type: string description: >- The last recipient of outreach that was sent for this partner (email address or phone number). nullable: true last_synced_at: type: string format: date-time nullable: true legal_name: type: string description: The legal name of this partner, typically applies to businesses. nullable: true linked_integration: $ref: '#/components/schemas/LinkedIntegration' modified_at: type: string format: date-time nullable: true name: type: string description: The full name of the partner. nullable: true num_open_invoices: type: integer object: type: string oldest_open_invoice_due_date: type: string format: date-time on_behalf_of: type: string description: >- The name of the person or entity your organization is contacting this customer for. nullable: true on_behalf_of_phone: type: string maxLength: 32 description: >- The number of the person or entity your organization is contacting this customer for. nullable: true organization_id: type: string maxLength: 32 parent_id: type: string maxLength: 32 nullable: true phone: type: string maxLength: 32 description: The partner's default phone number. nullable: true recent_payments: type: number remote_created_at: type: string format: date-time description: When the third party's entry was created. nullable: true remote_id: type: string description: The partner's third party id. remote_metadata: nullable: true remote_modified_at: type: string format: date-time description: When the third party's entry was updated. nullable: true remote_parent_id: type: string description: The partner's third party parent partner id. nullable: true remote_payment_portal_url: type: string description: The partner's third party payment portal url. nullable: true shipping_address: $ref: '#/components/schemas/Address' status_metadata: description: >- Holds metadata about why contact channel statuses changed,, has source (email or call) as key values (e.g. {'email'|'phone': {status: 'enabled'|'disabled', reason: str, timestamp: datetime}}) stuut_health_score: type: number sync_status: maxLength: 7 description: The sync status for this entity. enum: - partial - syncing - synced - failed tags: type: array items: $ref: '#/components/schemas/PartnerTag' tax_number: type: string description: >- Tax number - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global). nullable: true timezone: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu maxLength: 50 total_overdue: type: number type: enum: - customer - vendor - both required: - invoice_balance - is_call_outreach_manually_paused - is_contact_enrichment_enabled - is_email_outreach_manually_paused - last_inbound_at - num_open_invoices - object - organization_id - remote_id - total_overdue - type StuutErrorHTTP: type: object properties: data: type: object additionalProperties: {} error: type: string message: type: string required: - data - error - message APPortal: type: object properties: id: type: string maxLength: 32 account: $ref: '#/components/schemas/APPortalAccount' account_id: type: string maxLength: 32 description: Reference to the ap portal account nullable: true account_key: type: string description: >- Identifier to scope an AP Portal (e.g. region, division, department). nullable: true created_at: type: string format: date-time customer_identifier: type: string description: Customer identifier on the portal, if exists. nullable: true customer_name: type: string description: >- Customer name on the portal. Used instead of the partner name if set. nullable: true invoice_submission_guidelines: type: string description: Natural language guidelines for processing invoice submissions. nullable: true is_enabled: type: boolean description: Whether this AP portal configuration is enabled is_invoice_submission_enabled: type: boolean description: Whether invoice submission is enabled is_report_download_enabled: type: boolean description: Whether report download is enabled modified_at: type: string format: date-time nullable: true name: type: string description: Name of the AP Portal nullable: true object: type: string partner_id: type: string maxLength: 32 description: Reference to the Partner provider: maxLength: 6 description: The AP Portal provider enum: - coupa - ariba - taulia - null nullable: true report_email: type: string description: Email address to send downloaded reports to nullable: true report_frequency: maxLength: 7 description: Frequency for report downloads enum: - daily - weekly - monthly - null nullable: true required: - object - partner_id User: type: object properties: id: type: string maxLength: 32 created_at: type: string format: date-time dashboard_settings: $ref: '#/components/schemas/DashboardSettings' default_email_sender_id: type: string maxLength: 32 nullable: true email: type: string maxLength: 255 family_name: type: string given_name: type: string invited_by_user_id: type: string maxLength: 32 nullable: true is_access_approved: type: boolean is_org_admin: type: boolean modified_at: type: string format: date-time nullable: true name: type: string readOnly: true object: type: string onboarding_required: type: boolean organization_id: type: string maxLength: 32 profile_picture: type: string selected: type: boolean required: - email - family_name - given_name - object - organization_id Address: type: object properties: city: type: string description: City, district, suburb, town, or village. nullable: true coordinates: anyOf: - type: object nullable: true - $ref: '#/components/schemas/Coordinates' country: type: string maxLength: 3 description: >- Two-letter country code. [(ISO 3166 alpha-2)](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) nullable: true created_at: type: string format: date-time description: type: string nullable: true line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). nullable: true line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). nullable: true modified_at: type: string format: date-time nullable: true name: type: string nullable: true object: type: string phone: type: string maxLength: 20 nullable: true postal_code: type: string description: ZIP or postal code. nullable: true remote_id: type: string description: The address' third party API ID. nullable: true state: type: string description: State, county, province, or region. nullable: true type: type: string description: >- Whether the address is a shipping, billing, or other type of address. required: - object Contact: type: object properties: id: type: string maxLength: 32 address: $ref: '#/components/schemas/Address' address_id: type: integer nullable: true addresses: type: array items: $ref: '#/components/schemas/ContactAddress' created_at: type: string format: date-time custom_fields: {} email: type: string maxLength: 255 description: The contact's email address. external_role: maxLength: 15 description: The external contact's role. enum: - billing_contact - executive - economic_user - null nullable: true family_name: type: string description: If an individual, the contact's family name. nullable: true given_name: type: string description: If an individual, the contact's given name. nullable: true internal_role: maxLength: 17 description: The internal contact's role. enum: - account_manager - account_executive - csm - null nullable: true is_email_disabled: type: boolean description: Whether the contact's email has been deemed invalid. is_phone_disabled: type: boolean description: Whether the contact's email has been deemed invalid. is_primary: type: boolean description: Whether the contact is a primary contact for the partner. is_primary_email: type: boolean description: Whether the contact is the primary email contact for the partner. is_primary_phone: type: boolean description: Whether the contact is the primary phone contact for the partner. job_title: type: string description: The contact's job at their company. nullable: true modified_at: type: string format: date-time nullable: true name: type: string description: The contact's name, if no given/family name. nullable: true object: type: string partner_id: type: string maxLength: 32 phone: type: string maxLength: 32 description: The contact's phone number. nullable: true remote_created_at: type: string format: date-time description: When the third party's entry was created. nullable: true remote_id: type: string description: The contact's third party API ID. nullable: true remote_metadata: nullable: true remote_modified_at: type: string format: date-time description: When the third party's entry was updated. nullable: true status_metadata: description: >- Holds metadata about why contact channel statuses changed, has source (email or call) as key values (e.g. {'email'|'call': {status: 'enabled'|'disabled', reason: str, timestamp: datetime}}) required: - email - object - partner_id LinkedIntegration: type: object properties: id: type: string maxLength: 32 api_subdomain: type: string nullable: true api_url: type: string nullable: true connection_info: nullable: true created_at: type: string format: date-time credentials_expire_at: type: string format: date-time description: The time at which the credentials expire. nullable: true health: $ref: '#/components/schemas/LinkedIntegrationHealth' identity_info: nullable: true integration: $ref: '#/components/schemas/Integration' integration_name: type: string is_configured: type: boolean is_running_setup: type: boolean is_sync_disabled: type: boolean description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. is_webhooks_enabled: type: boolean models: type: array items: $ref: '#/components/schemas/LinkedModel' modified_at: type: string format: date-time nullable: true name: type: string description: User defined name of the linked integration. nullable: true object: type: string owner_id: type: string maxLength: 32 nullable: true requires_setup: type: boolean settings: type: object additionalProperties: {} username: type: string nullable: true webhook_listener_url: type: string nullable: true webhook_setup_error: type: string nullable: true required: - integration_name - is_configured - object - settings PartnerTag: type: object properties: created_at: type: string format: date-time is_manual: type: boolean description: >- Whether the tag was manually assigned to the partner or automatically matched using rules modified_at: type: string format: date-time nullable: true object: type: string partner_id: type: string maxLength: 32 tag: $ref: '#/components/schemas/Tag' tag_id: type: string maxLength: 32 required: - object - partner_id - tag_id APPortalAccount: type: object properties: id: type: string maxLength: 32 available_operations: readOnly: true created_at: type: string format: date-time modified_at: type: string format: date-time nullable: true object: type: string organization_id: type: string maxLength: 32 description: Organization associated with this account provider: maxLength: 6 description: The AP Portal provider enum: - coupa - ariba - taulia required: - object - organization_id - provider DashboardSettings: type: object properties: thread_emails_sort_order: type: string default: asc Coordinates: type: object properties: lat: type: number lng: type: number required: - lat - lng ContactAddress: type: object properties: id: type: string maxLength: 32 city: type: string description: City, district, suburb, town, or village. nullable: true coordinates: anyOf: - type: object nullable: true - $ref: '#/components/schemas/Coordinates' country: type: string maxLength: 3 description: >- Two-letter country code. [(ISO 3166 alpha-2)](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) nullable: true created_at: type: string format: date-time description: type: string nullable: true is_primary: type: boolean line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). nullable: true line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). nullable: true modified_at: type: string format: date-time nullable: true name: type: string nullable: true object: type: string postal_code: type: string description: ZIP or postal code. nullable: true state: type: string description: State, county, province, or region. nullable: true type: type: string description: >- Whether the address is a shipping, billing, or other type of address. required: - object LinkedIntegrationHealth: type: object properties: status: enum: - incomplete - relink_required - unhealthy - healthy details: type: object default: null additionalProperties: nullable: true nullable: true message: type: string default: null nullable: true reason: default: null enum: - invalid_credentials - missing_permission - missing_settings - unknown_error - connection_issue - timeout - null nullable: true required: - status Integration: type: object properties: api_base_url: type: string api_documentation_url: type: string default: null nullable: true api_requires_subdomain: type: boolean default: false auth_type: default: null enum: - api_key - basic - custom - oauth1 - oauth2 - oauth2_cc - null nullable: true categories: type: array items: enum: - accounting - banking - crm - file-storage - communication color: type: string default: null nullable: true connection_guide_url: type: string default: null nullable: true connection_instructions: type: array default: null items: type: string nullable: true connection_steps: type: array items: $ref: '#/components/schemas/IntegrationStep' created_at: type: string format: date-time description: type: string default: null nullable: true display_name: type: string is_enabled: type: boolean default: true logo: type: string default: null nullable: true logo_square: type: string default: null nullable: true modified_at: type: string format: date-time nullable: true name: type: string object: type: string settings: type: array items: $ref: '#/components/schemas/IntegrationSetting' short_description: type: string default: null nullable: true required: - display_name - name - object LinkedModel: type: object properties: id: type: string maxLength: 32 created_at: type: string format: date-time exclude_rule: $ref: '#/components/schemas/Condition' field_mappings: nullable: true health: $ref: '#/components/schemas/LinkedModelHealth' integration_schema_id: type: string maxLength: 32 is_read_enabled: type: boolean is_webhooks_setup: type: boolean is_write_enabled: type: boolean last_sync: $ref: '#/components/schemas/LinkedModelSync' last_sync_id: type: string maxLength: 32 nullable: true linked_integration_id: type: string maxLength: 32 modified_at: type: string format: date-time nullable: true name: type: string next_sync_at: type: string format: date-time nullable: true object: type: string sync_requested: type: boolean required: - integration_schema_id - linked_integration_id - name - object Tag: type: object properties: id: type: string maxLength: 32 color: type: string maxLength: 20 description: The hex color code of the tag, if any. created_at: type: string format: date-time modified_at: type: string format: date-time nullable: true name: type: string description: The name of the tag. object: type: string rule_condition: $ref: '#/components/schemas/Condition' required: - name - object IntegrationStep: type: object properties: type: enum: - fetch - form - quickbooks-desktop title: type: string description: type: string default: null nullable: true endpoint: type: string default: null nullable: true fields: type: array default: null items: $ref: '#/components/schemas/IntegrationStepFormField' nullable: true post_auth: type: boolean default: false required: - title - type IntegrationSetting: type: object properties: key: type: string type: enum: - any - array - boolean - integer - number - object - string choices: type: array default: null items: $ref: '#/components/schemas/IntegrationSettingChoice' nullable: true description: type: string default: null nullable: true format: default: text enum: - binary - byte - color - date - datetime - date-time - decimal - double - email - enum - float - hostname - password - tel - text - time - timestamp - uri - uuid description: The format of the choice. group: type: string default: null nullable: true guide_url: type: string default: null nullable: true is_editable: type: boolean default: false is_required: type: boolean default: true is_select: type: boolean default: false label: type: string default: null nullable: true post_auth: type: boolean default: false requires_load: type: boolean default: false required: - key - type Condition: type: object properties: {} LinkedModelHealth: type: object properties: status: enum: - incomplete - unhealthy - healthy details: type: object default: null additionalProperties: nullable: true nullable: true message: type: string default: null nullable: true reason: default: null enum: - incomplete_field_mappings - missing_integration_schema - missing_permission - unknown_error - connection_issue - timeout - null nullable: true required: - status LinkedModelSync: type: object properties: id: type: string maxLength: 32 created_at: type: string format: date-time entity_id: type: string nullable: true is_initial_sync: type: boolean is_one_off: type: boolean description: Whether or not this is a one off sync linked_model_id: type: string maxLength: 32 modified_at: type: string format: date-time nullable: true object: type: string pagination: nullable: true run: $ref: '#/components/schemas/FunctionRun' run_id: type: string maxLength: 32 timerange_end: type: string format: date-time nullable: true timerange_start: type: string format: date-time nullable: true required: - linked_model_id - object - run_id IntegrationStepFormField: type: object properties: setting: type: string default: null nullable: true IntegrationSettingChoice: type: object properties: label: type: string description: The label of the choice. value: description: The value of the choice. required: - label - value FunctionRun: type: object properties: id: type: string maxLength: 32 completed_at: type: string format: date-time nullable: true created_at: type: string format: date-time data: nullable: true event_id: type: string maxLength: 32 nullable: true modified_at: type: string format: date-time nullable: true object: type: string output: nullable: true remote_id: type: string description: The external id of the function run (e.g. inngest function run id) nullable: true stacktrace: type: string nullable: true started_at: type: string format: date-time nullable: true status: maxLength: 13 enum: - scheduled - queued - skipped - running - cancelled - failed - pending_retry - complete required: - object securitySchemes: BearerAuth: type: http scheme: bearer ````