Skip to main content
POST
/
v1
/
invoices
/
{invoice_id}
/
sync
Sync An Invoice
curl --request POST \
  --url http://api.stuut.ai/v1/invoices/{invoice_id}/sync \
  --header 'Authorization: Bearer <token>'
{
  "amount_due": 123,
  "currency": "ADP",
  "object": "<string>",
  "remote_id": "<string>",
  "total_amount": 123,
  "id": "<string>",
  "amount_paid": 123,
  "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
  },
  "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,
  "billing_email": "<string>",
  "calls": [
    {
      "direction": "inbound",
      "object": "<string>",
      "to_number": "<string>",
      "id": "<string>",
      "agent_id": "<string>",
      "approver": {
        "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
      },
      "approver_id": "<string>",
      "call_agent_id": "<string>",
      "call_reason": "<string>",
      "classifications": [
        {
          "agent_reply_reason": "<string>",
          "classification": "payment_inquiry",
          "is_action_required": true,
          "is_reply_required": true,
          "object": "<string>",
          "reason": "<string>",
          "action_recommendation": "<string>",
          "agent_confidence_reason": "<string>",
          "agent_confidence_score": 123,
          "agent_error_code": "<string>",
          "agent_uncertainties": [
            "<string>"
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "language": "<string>",
          "modified_at": "2023-11-07T05:31:56Z",
          "tasks": [
            {
              "label": "<string>",
              "object": "<string>",
              "organization_id": "<string>",
              "type": "activity_summary_outreach",
              "id": "<string>",
              "action_taken": "complete",
              "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>",
              "close_reason": "<string>",
              "completed_action": {},
              "created_at": "2023-11-07T05:31:56Z",
              "data": [
                {
                  "object": "<string>",
                  "source": "email",
                  "task_id": "<string>",
                  "type": "response",
                  "id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "data": "<unknown>",
                  "modified_at": "2023-11-07T05:31:56Z"
                }
              ],
              "description": "<string>",
              "error_reason": "<string>",
              "modified_at": "2023-11-07T05:31:56Z",
              "status": "open",
              "trigger_event": {
                "name": "<string>",
                "object": "<string>",
                "id": "<string>",
                "actor_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "data": null,
                "entity": "<unknown>",
                "entity_id": "<string>",
                "message": "<string>",
                "modified_at": "2023-11-07T05:31:56Z",
                "timestamp": "2023-11-07T05:31:56Z"
              },
              "trigger_event_id": "<string>"
            }
          ]
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "custom_classifications": [
        "<string>"
      ],
      "disconnection_reason": "<string>",
      "end_time": "2023-11-07T05:31:56Z",
      "from_number": "<string>",
      "in_voicemail": true,
      "invoices": "<array>",
      "is_automated": true,
      "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,
        "contacts": [
          {
            "email": "<string>",
            "object": "<string>",
            "partner_id": "<string>",
            "id": "<string>",
            "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>"
            },
            "address_id": 123,
            "addresses": [
              {
                "object": "<string>",
                "id": "<string>",
                "city": "<string>",
                "coordinates": {},
                "country": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "description": "<string>",
                "is_primary": true,
                "line1": "<string>",
                "line2": "<string>",
                "modified_at": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "postal_code": "<string>",
                "state": "<string>",
                "type": "<string>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "custom_fields": "<unknown>",
            "external_role": "billing_contact",
            "family_name": "<string>",
            "given_name": "<string>",
            "internal_role": "account_manager",
            "is_email_disabled": true,
            "is_phone_disabled": true,
            "is_primary": true,
            "is_primary_email": true,
            "is_primary_phone": true,
            "job_title": "<string>",
            "modified_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "phone": "<string>",
            "remote_created_at": "2023-11-07T05:31:56Z",
            "remote_id": "<string>",
            "remote_metadata": null,
            "remote_modified_at": "2023-11-07T05:31:56Z",
            "status_metadata": "<unknown>"
          }
        ],
        "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>",
        "linked_integration": {
          "integration_name": "<string>",
          "is_configured": true,
          "object": "<string>",
          "settings": {},
          "id": "<string>",
          "api_subdomain": "<string>",
          "api_url": "<string>",
          "connection_info": null,
          "created_at": "2023-11-07T05:31:56Z",
          "credentials_expire_at": "2023-11-07T05:31:56Z",
          "health": {
            "status": "incomplete",
            "details": null,
            "message": null,
            "reason": null
          },
          "identity_info": null,
          "integration": {
            "display_name": "<string>",
            "name": "<string>",
            "object": "<string>",
            "api_base_url": "<string>",
            "api_documentation_url": null,
            "api_requires_subdomain": false,
            "auth_type": null,
            "categories": [
              "accounting"
            ],
            "color": null,
            "connection_guide_url": null,
            "connection_instructions": null,
            "connection_steps": [
              {
                "type": "fetch",
                "title": "<string>",
                "description": null,
                "endpoint": null,
                "fields": null,
                "post_auth": false
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "description": null,
            "is_enabled": true,
            "logo": null,
            "logo_square": null,
            "modified_at": "2023-11-07T05:31:56Z",
            "settings": [
              {
                "key": "<string>",
                "type": "any",
                "choices": null,
                "description": null,
                "format": "text",
                "group": null,
                "guide_url": null,
                "is_editable": false,
                "is_required": true,
                "is_select": false,
                "label": null,
                "post_auth": false,
                "requires_load": false
              }
            ],
            "short_description": null
          },
          "is_running_setup": true,
          "is_sync_disabled": true,
          "is_webhooks_enabled": true,
          "models": [
            {
              "integration_schema_id": "<string>",
              "linked_integration_id": "<string>",
              "name": "<string>",
              "object": "<string>",
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "exclude_rule": {},
              "field_mappings": null,
              "health": {
                "status": "incomplete",
                "details": null,
                "message": null,
                "reason": null
              },
              "is_read_enabled": true,
              "is_webhooks_setup": true,
              "is_write_enabled": true,
              "last_sync": {
                "linked_model_id": "<string>",
                "object": "<string>",
                "run_id": "<string>",
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "entity_id": "<string>",
                "is_initial_sync": true,
                "is_one_off": true,
                "modified_at": "2023-11-07T05:31:56Z",
                "pagination": null,
                "run": {
                  "object": "<string>",
                  "id": "<string>",
                  "completed_at": "2023-11-07T05:31:56Z",
                  "created_at": "2023-11-07T05:31:56Z",
                  "data": null,
                  "event_id": "<string>",
                  "modified_at": "2023-11-07T05:31:56Z",
                  "output": null,
                  "remote_id": "<string>",
                  "stacktrace": "<string>",
                  "started_at": "2023-11-07T05:31:56Z",
                  "status": "scheduled"
                },
                "timerange_end": "2023-11-07T05:31:56Z",
                "timerange_start": "2023-11-07T05:31:56Z"
              },
              "last_sync_id": "<string>",
              "modified_at": "2023-11-07T05:31:56Z",
              "next_sync_at": "2023-11-07T05:31:56Z",
              "sync_requested": true
            }
          ],
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "owner_id": "<string>",
          "requires_setup": true,
          "username": "<string>",
          "webhook_listener_url": "<string>",
          "webhook_setup_error": "<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": null,
        "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"
      },
      "partner_id": "<string>",
      "recording_url": "<unknown>",
      "retell_id": "<string>",
      "sentiment": "positive",
      "start_time": "2023-11-07T05:31:56Z",
      "status": "pending_approval",
      "summary": "<string>",
      "transcript": "<unknown>",
      "transcript_str": "<string>",
      "transferred_to": "<string>",
      "workflow": {
        "id": "<string>",
        "active_days": [
          123
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "email_sender_id": "<string>",
        "is_active": true,
        "is_call_on_weekend_enabled": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "object": "<string>",
        "outreach_window_end": "<string>",
        "outreach_window_start": "<string>",
        "pending_run_strategy": "send_all",
        "test_email": "<string>",
        "test_phone_number": "<string>",
        "timezone": "Africa/Abidjan"
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "custom_fields": "<unknown>",
  "due_date": "2023-11-07T05:31:56Z",
  "emails": [
    {
      "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": [
        "jsmith@example.com"
      ],
      "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>"
      ]
    }
  ],
  "in_dispute": true,
  "is_issued_email_sent": true,
  "issued_at": "2023-11-07T05:31:56Z",
  "last_outreach_at": "2023-11-07T05:31:56Z",
  "last_outreach_channel": "email",
  "last_outreach_to": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "line_items": [
    {
      "invoice_id": "<string>",
      "object": "<string>",
      "remote_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "ADP",
      "custom_fields": "<unknown>",
      "description": "<string>",
      "line_number": 123,
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "period_end_date": "2023-11-07T05:31:56Z",
      "period_start_date": "2023-11-07T05:31:56Z",
      "product_type": "<string>",
      "quantity": 123,
      "remote_created_at": "2023-11-07T05:31:56Z",
      "remote_metadata": null,
      "remote_modified_at": "2023-11-07T05:31:56Z",
      "total_amount": 123,
      "total_discount": 123,
      "total_tax": 123,
      "unit_amount": 123
    }
  ],
  "linked_integration": {
    "integration_name": "<string>",
    "is_configured": true,
    "object": "<string>",
    "settings": {},
    "id": "<string>",
    "api_subdomain": "<string>",
    "api_url": "<string>",
    "connection_info": null,
    "created_at": "2023-11-07T05:31:56Z",
    "credentials_expire_at": "2023-11-07T05:31:56Z",
    "health": {
      "status": "incomplete",
      "details": null,
      "message": null,
      "reason": null
    },
    "identity_info": null,
    "integration": {
      "display_name": "<string>",
      "name": "<string>",
      "object": "<string>",
      "api_base_url": "<string>",
      "api_documentation_url": null,
      "api_requires_subdomain": false,
      "auth_type": null,
      "categories": [
        "accounting"
      ],
      "color": null,
      "connection_guide_url": null,
      "connection_instructions": null,
      "connection_steps": [
        {
          "type": "fetch",
          "title": "<string>",
          "description": null,
          "endpoint": null,
          "fields": null,
          "post_auth": false
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "description": null,
      "is_enabled": true,
      "logo": null,
      "logo_square": null,
      "modified_at": "2023-11-07T05:31:56Z",
      "settings": [
        {
          "key": "<string>",
          "type": "any",
          "choices": null,
          "description": null,
          "format": "text",
          "group": null,
          "guide_url": null,
          "is_editable": false,
          "is_required": true,
          "is_select": false,
          "label": null,
          "post_auth": false,
          "requires_load": false
        }
      ],
      "short_description": null
    },
    "is_running_setup": true,
    "is_sync_disabled": true,
    "is_webhooks_enabled": true,
    "models": [
      {
        "integration_schema_id": "<string>",
        "linked_integration_id": "<string>",
        "name": "<string>",
        "object": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "exclude_rule": {},
        "field_mappings": null,
        "health": {
          "status": "incomplete",
          "details": null,
          "message": null,
          "reason": null
        },
        "is_read_enabled": true,
        "is_webhooks_setup": true,
        "is_write_enabled": true,
        "last_sync": {
          "linked_model_id": "<string>",
          "object": "<string>",
          "run_id": "<string>",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "entity_id": "<string>",
          "is_initial_sync": true,
          "is_one_off": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "pagination": null,
          "run": {
            "object": "<string>",
            "id": "<string>",
            "completed_at": "2023-11-07T05:31:56Z",
            "created_at": "2023-11-07T05:31:56Z",
            "data": null,
            "event_id": "<string>",
            "modified_at": "2023-11-07T05:31:56Z",
            "output": null,
            "remote_id": "<string>",
            "stacktrace": "<string>",
            "started_at": "2023-11-07T05:31:56Z",
            "status": "scheduled"
          },
          "timerange_end": "2023-11-07T05:31:56Z",
          "timerange_start": "2023-11-07T05:31:56Z"
        },
        "last_sync_id": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "next_sync_at": "2023-11-07T05:31:56Z",
        "sync_requested": true
      }
    ],
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "owner_id": "<string>",
    "requires_setup": true,
    "username": "<string>",
    "webhook_listener_url": "<string>",
    "webhook_setup_error": "<string>"
  },
  "marked_uncollectible_at": "2023-11-07T05:31:56Z",
  "memo": "<string>",
  "modified_at": "2023-11-07T05:31:56Z",
  "number": "<string>",
  "order_number": "<string>",
  "paid_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,
    "contacts": [
      {
        "email": "<string>",
        "object": "<string>",
        "partner_id": "<string>",
        "id": "<string>",
        "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>"
        },
        "address_id": 123,
        "addresses": [
          {
            "object": "<string>",
            "id": "<string>",
            "city": "<string>",
            "coordinates": {},
            "country": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "is_primary": true,
            "line1": "<string>",
            "line2": "<string>",
            "modified_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "postal_code": "<string>",
            "state": "<string>",
            "type": "<string>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "custom_fields": "<unknown>",
        "external_role": "billing_contact",
        "family_name": "<string>",
        "given_name": "<string>",
        "internal_role": "account_manager",
        "is_email_disabled": true,
        "is_phone_disabled": true,
        "is_primary": true,
        "is_primary_email": true,
        "is_primary_phone": true,
        "job_title": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "phone": "<string>",
        "remote_created_at": "2023-11-07T05:31:56Z",
        "remote_id": "<string>",
        "remote_metadata": null,
        "remote_modified_at": "2023-11-07T05:31:56Z",
        "status_metadata": "<unknown>"
      }
    ],
    "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_call_outreach_manually_paused": true,
    "is_company": true,
    "is_email_disabled": true,
    "is_email_outreach_manually_paused": 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>",
    "linked_integration": {
      "integration_name": "<string>",
      "is_configured": true,
      "object": "<string>",
      "settings": {},
      "id": "<string>",
      "api_subdomain": "<string>",
      "api_url": "<string>",
      "connection_info": null,
      "created_at": "2023-11-07T05:31:56Z",
      "credentials_expire_at": "2023-11-07T05:31:56Z",
      "health": {
        "status": "incomplete",
        "details": null,
        "message": null,
        "reason": null
      },
      "identity_info": null,
      "integration": {
        "display_name": "<string>",
        "name": "<string>",
        "object": "<string>",
        "api_base_url": "<string>",
        "api_documentation_url": null,
        "api_requires_subdomain": false,
        "auth_type": null,
        "categories": [
          "accounting"
        ],
        "color": null,
        "connection_guide_url": null,
        "connection_instructions": null,
        "connection_steps": [
          {
            "type": "fetch",
            "title": "<string>",
            "description": null,
            "endpoint": null,
            "fields": null,
            "post_auth": false
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "description": null,
        "is_enabled": true,
        "logo": null,
        "logo_square": null,
        "modified_at": "2023-11-07T05:31:56Z",
        "settings": [
          {
            "key": "<string>",
            "type": "any",
            "choices": null,
            "description": null,
            "format": "text",
            "group": null,
            "guide_url": null,
            "is_editable": false,
            "is_required": true,
            "is_select": false,
            "label": null,
            "post_auth": false,
            "requires_load": false
          }
        ],
        "short_description": null
      },
      "is_running_setup": true,
      "is_sync_disabled": true,
      "is_webhooks_enabled": true,
      "models": [
        {
          "integration_schema_id": "<string>",
          "linked_integration_id": "<string>",
          "name": "<string>",
          "object": "<string>",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "exclude_rule": {},
          "field_mappings": null,
          "health": {
            "status": "incomplete",
            "details": null,
            "message": null,
            "reason": null
          },
          "is_read_enabled": true,
          "is_webhooks_setup": true,
          "is_write_enabled": true,
          "last_sync": {
            "linked_model_id": "<string>",
            "object": "<string>",
            "run_id": "<string>",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "entity_id": "<string>",
            "is_initial_sync": true,
            "is_one_off": true,
            "modified_at": "2023-11-07T05:31:56Z",
            "pagination": null,
            "run": {
              "object": "<string>",
              "id": "<string>",
              "completed_at": "2023-11-07T05:31:56Z",
              "created_at": "2023-11-07T05:31:56Z",
              "data": null,
              "event_id": "<string>",
              "modified_at": "2023-11-07T05:31:56Z",
              "output": null,
              "remote_id": "<string>",
              "stacktrace": "<string>",
              "started_at": "2023-11-07T05:31:56Z",
              "status": "scheduled"
            },
            "timerange_end": "2023-11-07T05:31:56Z",
            "timerange_start": "2023-11-07T05:31:56Z"
          },
          "last_sync_id": "<string>",
          "modified_at": "2023-11-07T05:31:56Z",
          "next_sync_at": "2023-11-07T05:31:56Z",
          "sync_requested": true
        }
      ],
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "owner_id": "<string>",
      "requires_setup": true,
      "username": "<string>",
      "webhook_listener_url": "<string>",
      "webhook_setup_error": "<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": null,
    "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"
  },
  "partner_id": "<string>",
  "payments": [
    {
      "amount": 123,
      "invoice_id": "<string>",
      "object": "<string>",
      "payment_id": "<string>",
      "strategy": "automatic",
      "id": "<string>",
      "agent_confidence_reason": "<string>",
      "agent_confidence_score": 123,
      "agent_error_code": "<string>",
      "agent_uncertainties": [
        "<string>"
      ],
      "approved": true,
      "approved_at": "2023-11-07T05:31:56Z",
      "approver_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "payment": {
        "id": "<string>",
        "agent_confidence_reason": "<string>",
        "agent_confidence_score": 123,
        "agent_error_code": "<string>",
        "agent_uncertainties": [
          "<string>"
        ],
        "amount": 123,
        "amount_refunded": 123,
        "bank_transaction_id": "<string>",
        "billing_email": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "ADP",
        "currency_rate": 123,
        "custom_fields": "<unknown>",
        "description": "<string>",
        "expected_at": "2023-11-07T05:31:56Z",
        "finix_transfer_id": "<string>",
        "initiated_at": "2023-11-07T05:31:56Z",
        "last_exported_at": "2023-11-07T05:31:56Z",
        "last_synced_at": "2023-11-07T05:31:56Z",
        "linked_integration_id": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "object": "<string>",
        "partner_id": "<string>",
        "payment_method": "ach",
        "receipt_url": "<string>",
        "reference_number": "<string>",
        "remittance_id": "<string>",
        "remote_created_at": "2023-11-07T05:31:56Z",
        "remote_id": "<string>",
        "remote_metadata": null,
        "remote_modified_at": "2023-11-07T05:31:56Z",
        "statement_descriptor": "<string>",
        "status": "pending_match",
        "stripe_session_id": "<string>",
        "sync_status": "partial",
        "timestamp": "2023-11-07T05:31:56Z",
        "transaction_match_approved_at": "2023-11-07T05:31:56Z",
        "transaction_match_approver_id": "<string>"
      },
      "remote_id": "<string>"
    }
  ],
  "pdf": "<unknown>",
  "pdf_id": "<string>",
  "period_end_date": "2023-11-07T05:31:56Z",
  "period_start_date": "2023-11-07T05:31:56Z",
  "private_note": "<string>",
  "promised_to_pay_date": "2023-12-25",
  "purchase_order_number": "<string>",
  "remote_created_at": "2023-11-07T05:31:56Z",
  "remote_invoice_pdf": "<string>",
  "remote_metadata": null,
  "remote_modified_at": "2023-11-07T05:31:56Z",
  "remote_partner_id": "<string>",
  "remote_payment_portal_url": "<string>",
  "remote_payment_status": "processing",
  "remote_status": "<string>",
  "requires_line_item_sync": true,
  "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>"
  },
  "shipping_address_id": 123,
  "status": "<unknown>",
  "subtotal": 123,
  "sync_status": "partial",
  "total_discount": 123,
  "total_tax": 123,
  "type": "payable",
  "voided_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
invoice_id
string
required

Response

Successful response

​
amount_due
integer
required

The amount to be paid on invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

​
currency
enum<string>
required

The invoice's 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: 3
​
object
string
required
​
remote_id
string
required

The invoice's third party API ID.

​
total_amount
integer
required

The total amount of the invoice, including tax and allowances, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

​
id
string
Maximum string length: 32
​
amount_paid
integer

The invoice's total amount paid, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

​
assignee
object
​
billing_address
object
​
billing_address_id
integer | null
​
billing_email
string | null
Maximum string length: 255
​
calls
object[]
​
created_at
string<date-time>
​
custom_fields
any
​
due_date
string<date-time> | null

The invoice's due date.

​
emails
object[]
​
in_dispute
boolean

Whether an invoice is in dispute. If it is, we exclude it from any outreach.

​
is_issued_email_sent
boolean

Whether the email to notify the customer that the invoice has been issued was sent.

​
issued_at
string<date-time> | null

The invoice's issue date.

​
last_outreach_at
string<date-time> | null

The last date outreach was sent for this invoice.

​
last_outreach_channel
enum<string> | null

The last channel outreach was sent in for this invoice (phone or email).

Available options:
email,
call,
null
Maximum string length: 5
​
last_outreach_to
string | null

The last recipient of outreach that was sent for this invoice (email address or phone number).

​
last_synced_at
string<date-time> | null
​
line_items
object[]
​
linked_integration
object
​
marked_uncollectible_at
string<date-time> | null

The date the invoice was marked uncollectible.

​
memo
string | null

A memo visible to the invoice's end user.

​
modified_at
string<date-time> | null
​
number
string | null

A unique, identifying string that appears on emails sent to the customer for this invoice.

​
order_number
string | null

Unique identifier assigned to a purchase by a seller.

​
paid_at
string<date-time> | null

The date the invoice was paid.

​
partner
object
​
partner_id
string | null

The id of the customer this invoice is issued to.

Maximum string length: 32
​
payments
object[]
​
pdf
any
​
pdf_id
string | null
Maximum string length: 32
​
period_end_date
string<date-time> | null

End of the usage period during which invoice items were added to this invoice.

​
period_start_date
string<date-time> | null

Start of the usage period during which invoice items were added to this invoice.

​
private_note
string | null

The invoice's organization-private note.

​
promised_to_pay_date
string<date> | null

The date the customer has promised to pay the invoice.

​
purchase_order_number
string | null

Unique identifier assigned to a purchase order by a buyer.

​
remote_created_at
string<date-time> | null

When the third party's entry was created.

​
remote_invoice_pdf
string | null

The url to the invoice's third party pdf.

​
remote_metadata
unknown
​
remote_modified_at
string<date-time> | null

When the third party's entry was updated.

​
remote_partner_id
string | null

The invoice's partner's third party id.

​
remote_payment_portal_url
string | null

The invoice's third party payment url.

​
remote_payment_status
enum<string> | null

Status of payment on this invoice. NOTE: Source of this status could be different from the source of remote_status, and could be out of sync with it. It is currently controlled Stripe webhooks that receive partner portal session events. If payment was initiated and failed, remote_payment_status should be set to None.

Available options:
processing,
completed,
null
Maximum string length: 10
​
remote_status
string | null

The invoice's third party status.

​
requires_line_item_sync
boolean
​
shipping_address
object
​
shipping_address_id
integer | null
​
status
any
​
subtotal
integer

The total amount of the invoice, tax exclusive, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

​
sync_status
enum<string>

The sync status for this entity.

Available options:
partial,
syncing,
synced,
failed
Maximum string length: 7
​
total_discount
integer

The total discounts applied to the invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

​
total_tax
integer

The total tax applied to the invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

​
type
enum<string>

Whether the invoice is a PAYABLE (Accounts Payable) or RECEIVABLE (Accounts Receivable).

Available options:
payable,
receivable
Maximum string length: 10
​
voided_at
string<date-time> | null

The date the invoice was voided.