Analytics
Bank Accounts
Bank Statements
Bank Transactions
Call Agent Scenarios
Call Agents
Contact Suggestions
Email Senders
Email Template Folders
Email Templates
Email Threads
Emails
Files
Invoices
Organizations
Outreach Workflows
- GETList Outreach Workflows
- POSTCreate An Outreach Workflow
- GETRetrieve an Outreach Workflow
- POSTUpdate an Outreach Workflow
- DELDelete an Outreach Workflow
- GETList Outreach Workflow Stages
- POSTCreate An Outreach Workflow Stage
- GETRetrieve An Outreach Workflow Stage
- POSTUpdate An Outreach Workflow Stage
- DELDelete An Outreach Workflow Stage
Partners
Partner Contacts
Payments
Phone Numbers
Remittances
User Invites
Users
Upload A Remittance
Copy
curl --request POST \
--url http://api.stuut.ai/v1/remittances/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filename": "<string>",
"mime_type": "<string>",
"partner": "<string>"
}
'Copy
{
"presigned_url": {
"url": "<string>",
"fields": {}
},
"remittance": {
"object": "<string>",
"id": "<string>",
"agent_confidence_reason": "<string>",
"agent_confidence_score": 123,
"agent_error_code": "<string>",
"agent_uncertainties": [
"<string>"
],
"allocations": [
{
"invoice_number": "<string>",
"object": "<string>",
"remittance_id": "<string>",
"amount_discount": 123,
"amount_paid": 123,
"amount_withheld": 123,
"created_at": "2023-11-07T05:31:56Z",
"invoice": {
"amount_due": 123,
"currency": "<string>",
"id": "<string>",
"amount_paid": 123,
"due_date": "2023-11-07T05:31:56Z"
},
"invoice_id": "<string>",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"attachment": {
"file_type": "audio",
"mime_type": "<string>",
"name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"content_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"disposition": "<string>",
"is_verified": true,
"modified_at": "2023-11-07T05:31:56Z",
"presigned_url": "<string>",
"presigned_url_expires_at": "2023-11-07T05:31:56Z",
"purpose": "<string>",
"remote_id": "<string>",
"size": 123,
"src": "<unknown>",
"user_id": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"currency": "ADP",
"email": {
"object": "<string>",
"thread_id": "<string>",
"id": "<string>",
"attachments": [
{
"file_type": "audio",
"mime_type": "<string>",
"name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"content_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"disposition": "<string>",
"is_verified": true,
"modified_at": "2023-11-07T05:31:56Z",
"presigned_url": "<string>",
"presigned_url_expires_at": "2023-11-07T05:31:56Z",
"purpose": "<string>",
"remote_id": "<string>",
"size": 123,
"src": "<unknown>",
"user_id": "<string>"
}
],
"author": {
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"dashboard_settings": {
"thread_emails_sort_order": "asc"
},
"default_email_sender_id": "<string>",
"invited_by_user_id": "<string>",
"is_access_approved": true,
"is_org_admin": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"onboarding_required": true,
"profile_picture": "<string>",
"selected": true
},
"author_id": "<string>",
"bcc": [
"<string>"
],
"body": "<string>",
"bounced_addresses": [
"<string>"
],
"bulk_email_request_id": "<string>",
"cc": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"custom_headers": "<unknown>",
"direction": "inbound",
"email_reason": "<string>",
"email_sender": {
"email": "<string>",
"object": "<string>",
"reply_to": "<string>",
"user_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"is_nylas_connection": true,
"is_nylas_grant_expired": true,
"is_shared": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"provider": "<string>",
"reply_to_name": "<string>",
"signature_html": "<string>"
},
"email_sender_id": "<string>",
"error_message": "<string>",
"from_email": "<string>",
"generated_body": "<string>",
"is_automated": true,
"is_generated": true,
"is_originated_in_stuut": true,
"is_unread": true,
"modified_at": "2023-11-07T05:31:56Z",
"parent_email_id": "<string>",
"participants": [
"[email protected]"
],
"remote_id": "<string>",
"remote_links": [
{
"email_id": "<string>",
"email_sender_id": "<string>",
"object": "<string>",
"remote_id": "<string>",
"remote_thread_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"reply_to": [
"<string>"
],
"send_separately": true,
"sent_at": "2023-11-07T05:31:56Z",
"sent_by_id": "<string>",
"snippet": "<string>",
"status": "draft",
"subject": "<string>",
"to": [
"<string>"
]
},
"modified_at": "2023-11-07T05:31:56Z",
"partner": {
"id": "<string>",
"account_number": "<string>",
"ap_portals": [
{
"object": "<string>",
"partner_id": "<string>",
"id": "<string>",
"account": {
"object": "<string>",
"organization_id": "<string>",
"provider": "coupa",
"id": "<string>",
"available_operations": "<unknown>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"account_id": "<string>",
"account_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"customer_identifier": "<string>",
"customer_name": "<string>",
"invoice_submission_guidelines": "<string>",
"is_enabled": true,
"is_invoice_submission_enabled": true,
"is_report_download_enabled": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"provider": "coupa",
"report_email": "<string>",
"report_frequency": "daily"
}
],
"assignee": {
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"dashboard_settings": {
"thread_emails_sort_order": "asc"
},
"default_email_sender_id": "<string>",
"invited_by_user_id": "<string>",
"is_access_approved": true,
"is_org_admin": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"onboarding_required": true,
"profile_picture": "<string>",
"selected": true
},
"assignee_id": "<string>",
"billing_address": {
"object": "<string>",
"city": "<string>",
"coordinates": {},
"country": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"line1": "<string>",
"line2": "<string>",
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"remote_id": "<string>",
"state": "<string>",
"type": "<string>"
},
"billing_address_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"currency": "ADP",
"custom_fields": "<unknown>",
"description": "<string>",
"email": "<string>",
"family_name": "<string>",
"finix_identity_id": "<string>",
"given_name": "<string>",
"invoice_prefix": "<string>",
"is_active": true,
"is_company": true,
"is_email_disabled": true,
"is_phone_disabled": true,
"is_primary_email": true,
"is_primary_phone": true,
"last_outreach_at": "2023-11-07T05:31:56Z",
"last_outreach_channel": "email",
"last_outreach_to": "<string>",
"last_synced_at": "2023-11-07T05:31:56Z",
"legal_name": "<string>",
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"object": "<string>",
"on_behalf_of": "<string>",
"on_behalf_of_phone": "<string>",
"organization_id": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"remote_created_at": "2023-11-07T05:31:56Z",
"remote_id": "<string>",
"remote_metadata": "<unknown>",
"remote_modified_at": "2023-11-07T05:31:56Z",
"remote_parent_id": "<string>",
"remote_payment_portal_url": "<string>",
"shipping_address": {
"object": "<string>",
"city": "<string>",
"coordinates": {},
"country": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"line1": "<string>",
"line2": "<string>",
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"remote_id": "<string>",
"state": "<string>",
"type": "<string>"
},
"status_metadata": "<unknown>",
"sync_status": "partial",
"tags": [
{
"object": "<string>",
"partner_id": "<string>",
"tag_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_manual": true,
"modified_at": "2023-11-07T05:31:56Z",
"tag": {
"name": "<string>",
"object": "<string>",
"id": "<string>",
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"rule_condition": {}
}
}
],
"tax_number": "<string>",
"timezone": "Africa/Abidjan"
},
"payee_bank_details": {
"account_number": null,
"bank_name": null,
"bank_number": null,
"branch_number": null,
"iban": null,
"type": null
},
"payer_bank_details": {
"account_number": null,
"bank_name": null,
"bank_number": null,
"branch_number": null,
"iban": null,
"type": null
},
"payer_email": "<string>",
"payer_name": "<string>",
"payment_method": "<string>",
"status": "submitted",
"transaction_amount": 123,
"transaction_date": "2023-12-25",
"transaction_number": "<string>"
}
}Remittances
Upload A Remittance
POST
/
v1
/
remittances
/
upload
Upload A Remittance
Copy
curl --request POST \
--url http://api.stuut.ai/v1/remittances/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filename": "<string>",
"mime_type": "<string>",
"partner": "<string>"
}
'Copy
{
"presigned_url": {
"url": "<string>",
"fields": {}
},
"remittance": {
"object": "<string>",
"id": "<string>",
"agent_confidence_reason": "<string>",
"agent_confidence_score": 123,
"agent_error_code": "<string>",
"agent_uncertainties": [
"<string>"
],
"allocations": [
{
"invoice_number": "<string>",
"object": "<string>",
"remittance_id": "<string>",
"amount_discount": 123,
"amount_paid": 123,
"amount_withheld": 123,
"created_at": "2023-11-07T05:31:56Z",
"invoice": {
"amount_due": 123,
"currency": "<string>",
"id": "<string>",
"amount_paid": 123,
"due_date": "2023-11-07T05:31:56Z"
},
"invoice_id": "<string>",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"attachment": {
"file_type": "audio",
"mime_type": "<string>",
"name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"content_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"disposition": "<string>",
"is_verified": true,
"modified_at": "2023-11-07T05:31:56Z",
"presigned_url": "<string>",
"presigned_url_expires_at": "2023-11-07T05:31:56Z",
"purpose": "<string>",
"remote_id": "<string>",
"size": 123,
"src": "<unknown>",
"user_id": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"currency": "ADP",
"email": {
"object": "<string>",
"thread_id": "<string>",
"id": "<string>",
"attachments": [
{
"file_type": "audio",
"mime_type": "<string>",
"name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"content_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"disposition": "<string>",
"is_verified": true,
"modified_at": "2023-11-07T05:31:56Z",
"presigned_url": "<string>",
"presigned_url_expires_at": "2023-11-07T05:31:56Z",
"purpose": "<string>",
"remote_id": "<string>",
"size": 123,
"src": "<unknown>",
"user_id": "<string>"
}
],
"author": {
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"dashboard_settings": {
"thread_emails_sort_order": "asc"
},
"default_email_sender_id": "<string>",
"invited_by_user_id": "<string>",
"is_access_approved": true,
"is_org_admin": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"onboarding_required": true,
"profile_picture": "<string>",
"selected": true
},
"author_id": "<string>",
"bcc": [
"<string>"
],
"body": "<string>",
"bounced_addresses": [
"<string>"
],
"bulk_email_request_id": "<string>",
"cc": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"custom_headers": "<unknown>",
"direction": "inbound",
"email_reason": "<string>",
"email_sender": {
"email": "<string>",
"object": "<string>",
"reply_to": "<string>",
"user_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"is_nylas_connection": true,
"is_nylas_grant_expired": true,
"is_shared": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"provider": "<string>",
"reply_to_name": "<string>",
"signature_html": "<string>"
},
"email_sender_id": "<string>",
"error_message": "<string>",
"from_email": "<string>",
"generated_body": "<string>",
"is_automated": true,
"is_generated": true,
"is_originated_in_stuut": true,
"is_unread": true,
"modified_at": "2023-11-07T05:31:56Z",
"parent_email_id": "<string>",
"participants": [
"[email protected]"
],
"remote_id": "<string>",
"remote_links": [
{
"email_id": "<string>",
"email_sender_id": "<string>",
"object": "<string>",
"remote_id": "<string>",
"remote_thread_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"reply_to": [
"<string>"
],
"send_separately": true,
"sent_at": "2023-11-07T05:31:56Z",
"sent_by_id": "<string>",
"snippet": "<string>",
"status": "draft",
"subject": "<string>",
"to": [
"<string>"
]
},
"modified_at": "2023-11-07T05:31:56Z",
"partner": {
"id": "<string>",
"account_number": "<string>",
"ap_portals": [
{
"object": "<string>",
"partner_id": "<string>",
"id": "<string>",
"account": {
"object": "<string>",
"organization_id": "<string>",
"provider": "coupa",
"id": "<string>",
"available_operations": "<unknown>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"account_id": "<string>",
"account_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"customer_identifier": "<string>",
"customer_name": "<string>",
"invoice_submission_guidelines": "<string>",
"is_enabled": true,
"is_invoice_submission_enabled": true,
"is_report_download_enabled": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"provider": "coupa",
"report_email": "<string>",
"report_frequency": "daily"
}
],
"assignee": {
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"object": "<string>",
"organization_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"dashboard_settings": {
"thread_emails_sort_order": "asc"
},
"default_email_sender_id": "<string>",
"invited_by_user_id": "<string>",
"is_access_approved": true,
"is_org_admin": true,
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"onboarding_required": true,
"profile_picture": "<string>",
"selected": true
},
"assignee_id": "<string>",
"billing_address": {
"object": "<string>",
"city": "<string>",
"coordinates": {},
"country": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"line1": "<string>",
"line2": "<string>",
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"remote_id": "<string>",
"state": "<string>",
"type": "<string>"
},
"billing_address_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"currency": "ADP",
"custom_fields": "<unknown>",
"description": "<string>",
"email": "<string>",
"family_name": "<string>",
"finix_identity_id": "<string>",
"given_name": "<string>",
"invoice_prefix": "<string>",
"is_active": true,
"is_company": true,
"is_email_disabled": true,
"is_phone_disabled": true,
"is_primary_email": true,
"is_primary_phone": true,
"last_outreach_at": "2023-11-07T05:31:56Z",
"last_outreach_channel": "email",
"last_outreach_to": "<string>",
"last_synced_at": "2023-11-07T05:31:56Z",
"legal_name": "<string>",
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"object": "<string>",
"on_behalf_of": "<string>",
"on_behalf_of_phone": "<string>",
"organization_id": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"remote_created_at": "2023-11-07T05:31:56Z",
"remote_id": "<string>",
"remote_metadata": "<unknown>",
"remote_modified_at": "2023-11-07T05:31:56Z",
"remote_parent_id": "<string>",
"remote_payment_portal_url": "<string>",
"shipping_address": {
"object": "<string>",
"city": "<string>",
"coordinates": {},
"country": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"line1": "<string>",
"line2": "<string>",
"modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"remote_id": "<string>",
"state": "<string>",
"type": "<string>"
},
"status_metadata": "<unknown>",
"sync_status": "partial",
"tags": [
{
"object": "<string>",
"partner_id": "<string>",
"tag_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_manual": true,
"modified_at": "2023-11-07T05:31:56Z",
"tag": {
"name": "<string>",
"object": "<string>",
"id": "<string>",
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"rule_condition": {}
}
}
],
"tax_number": "<string>",
"timezone": "Africa/Abidjan"
},
"payee_bank_details": {
"account_number": null,
"bank_name": null,
"bank_number": null,
"branch_number": null,
"iban": null,
"type": null
},
"payer_bank_details": {
"account_number": null,
"bank_name": null,
"bank_number": null,
"branch_number": null,
"iban": null,
"type": null
},
"payer_email": "<string>",
"payer_name": "<string>",
"payment_method": "<string>",
"status": "submitted",
"transaction_amount": 123,
"transaction_date": "2023-12-25",
"transaction_number": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful response
Show child attributes
Show child attributes
Maximum string length:
32The justification for the agent's confidence score.
The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.
The code for why an error occurred when processing the statement.
A list of uncertainties we have regarding the result.
Show child attributes
Show child attributes
The invoice number.
Maximum string length:
32The total discount applied to an invoice, in the currency's smallest unit. e.g. $10 USD -> 1000
The total amount that was paid for the invoice, in the currency's smallest unit. e.g. $10 USD -> 1000
The total amount withheld on an invoice, in the currency's smallest unit. e.g. $10 USD -> 1000
Show child attributes
Show child attributes
The amount to be paid on invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)
The invoice's currency code (e.g. USD).
Maximum string length:
3Maximum string length:
32The invoice's total amount paid, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)
The invoice's due date.
The stuut id for the invoice
Maximum string length:
32Show child attributes
Show child attributes
Available options:
audio, document, gif, image, video Maximum string length:
8Maximum string length:
32Maximum string length:
32The use case for this attachment
The address' third party API ID.
Maximum string length:
32ISO 4217 currency code of the transaction.
Available options:
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, Maximum string length:
3Show child attributes
Show child attributes
Maximum string length:
32Maximum string length:
32Show child attributes
Show child attributes
Available options:
audio, document, gif, image, video Maximum string length:
8Maximum string length:
32Maximum string length:
32The use case for this attachment
The address' third party API ID.
Maximum string length:
32Show child attributes
Show child attributes
Maximum string length:
255Maximum string length:
32Maximum string length:
32Maximum string length:
32Maximum string length:
32Maximum string length:
32The HTML body of the email.
List of email addresses that bounced for this email
Maximum string length:
32Custom email headers
The request direction of the email. Either inbound or outbound
Available options:
inbound, outbound Maximum string length:
8The reason the email was sent.
Show child attributes
Show child attributes
The account's email.
Maximum string length:
255This account's default reply-to
Maximum string length:
255Maximum string length:
32Maximum string length:
32The time the email sender grant expired.
Whether the Nylas grant for this email sender has expired
Whether this email sender should be shared with the entire organization
Email owner's name.
This account's default reply-to
Email signature html.
Maximum string length:
32The error message if the email failed to send.
Saves LLM-generated body of the email. Diffed against email body when email is sent to get user changes.
Whether the email was automatically sent by a workflow or an AI agent.
Whether the email was automatically generated by a workflow or an AI agent.
Whether the email originated (was sent through) Stuut.
Maximum string length:
32The Nylas ID of the email
Show child attributes
Show child attributes
Maximum string length:
32Maximum string length:
32The ID of the email in a remote system, e.g. Nylas
The ID of the email thread in a remote system, e.g. Nylas
When the email was sent.
Maximum string length:
32Available options:
draft, pending, sending, sent, error Maximum string length:
7Show child attributes
Show child attributes
Maximum string length:
32The customer's account number.
Show child attributes
Show child attributes
Reference to the Partner
Maximum string length:
32Maximum string length:
32Show child attributes
Show child attributes
Organization associated with this account
Maximum string length:
32The AP Portal provider
Available options:
coupa, ariba, taulia Maximum string length:
6Maximum string length:
32Reference to the ap portal account
Maximum string length:
32Identifier to scope an AP Portal (e.g. region, division, department).
Customer identifier on the portal, if exists.
Customer name on the portal. Used instead of the partner name if set.
Natural language guidelines for processing invoice submissions.
Whether this AP portal configuration is enabled
Whether invoice submission is enabled
Whether report download is enabled
Name of the AP Portal
The AP Portal provider
Available options:
coupa, ariba, taulia, Maximum string length:
6Email address to send downloaded reports to
Frequency for report downloads
Available options:
daily, weekly, monthly, Maximum string length:
7Show child attributes
Show child attributes
Maximum string length:
255Maximum string length:
32Maximum string length:
32Maximum string length:
32Maximum string length:
32Maximum string length:
32Show child attributes
Show child attributes
City, district, suburb, town, or village.
- Option 1
- Option 2
Two-letter country code. (ISO 3166 alpha-2)
Maximum string length:
3Address line 1 (e.g., street, PO Box, or company name).
Address line 2 (e.g., apartment, suite, unit, or building).
Maximum string length:
20ZIP or postal code.
The address' third party API ID.
State, county, province, or region.
Whether the address is a shipping, billing, or other type of address.
The partner's default currency code (e.g. USD).
Available options:
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, Maximum string length:
3A description of the partner.
The partner's company email address.
Maximum string length:
255The partner's family name.
The partner's given name.
The prefix for this partner's invoice numbers.
Whether the partner is active.
Whether the partner is a company or individual.
Whether the partner's email address is no longer valid.
Whether the partner's email address is no longer valid.
Whether the partner's email is the primary email contact.
Whether the partner's phone number is the primary phone contact.
The last date outreach was sent for this partner.
The last channel outreach was sent in for this partner (phone or email).
Available options:
email, call, Maximum string length:
5The last recipient of outreach that was sent for this partner (email address or phone number).
The legal name of this partner, typically applies to businesses.
The full name of the partner.
The name of the person or entity your organization is contacting this customer for.
The number of the person or entity your organization is contacting this customer for.
Maximum string length:
32Maximum string length:
32Maximum string length:
32The partner's default phone number.
Maximum string length:
32When the third party's entry was created.
The partner's third party id.
When the third party's entry was updated.
The partner's third party parent partner id.
The partner's third party payment portal url.
Show child attributes
Show child attributes
City, district, suburb, town, or village.
- Option 1
- Option 2
Two-letter country code. (ISO 3166 alpha-2)
Maximum string length:
3Address line 1 (e.g., street, PO Box, or company name).
Address line 2 (e.g., apartment, suite, unit, or building).
Maximum string length:
20ZIP or postal code.
The address' third party API ID.
State, county, province, or region.
Whether the address is a shipping, billing, or other type of address.
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}})
The sync status for this entity.
Available options:
partial, syncing, synced, failed Maximum string length:
7Show child attributes
Show child attributes
Maximum string length:
32Maximum string length:
32Whether the tag was manually assigned to the partner or automatically matched using rules
Show child attributes
Show child attributes
The name of the tag.
Maximum string length:
32The hex color code of the tag, if any.
Maximum string length:
20Tax number - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global).
Available options:
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 Maximum string length:
50Show child attributes
Show child attributes
Available options:
CASH_MANAGEMENT, CHECKING, SAVINGS, CD, MONEY_MARKET, PAYPAL, OTHER, Show child attributes
Show child attributes
Available options:
CASH_MANAGEMENT, CHECKING, SAVINGS, CD, MONEY_MARKET, PAYPAL, OTHER, The email of the payer for this remittance.
The name of the payer for this remittance.
The payment method used to make the payment.
The status of this remittance advice.
Available options:
submitted, processing, invalid, pending_approval, approved Maximum string length:
16The total amount of the remittance in the currency's smallest unit, e.g. $10 USD -> 1000
The date the transaction was made or expected to be received.
The bank transaction number that was provided in this remittance.
⌘I