The Vendor object

A Rutter Vendor represents a business or contact that the business entity has purchased from. In some accounting systems, a vendor may be called a Supplier. The vendor object contains contact information as well as shipping and billing addresses.

Properties

idstring

The Rutter generated unique ID of the vendor.

platform_idstring

The platform specific ID of the vendor.

statusenum

The status of the address.

One ofactivearchived, or unknown.
contact_namestringnullable

The name of the primary contact associated with the vendor.

currency_codeenumnullable

The ISO 4217 currency code of the vendor.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
emailstringnullable

The email of the primary contact associated with the vendor.

phonestringnullable

The phone number of the primary contact associated with the vendor.

registration_numberstringnullable

The registration number of the vendor

tax_numberstringnullable

The tax number of the vendor.

vendor_namestringnullable

The name of the vendor.

websitestringnullable

The website associated with the vendor.

subsidiariesarray

An array of Subsidiaries linked to the vendor. This feature is currently only supported on NetSuite. A subsidiary_id query parameter can be optionally included in GET requests to filter the vendor results.

Show subsidiaries attributes
addressesarray

An array of addresses associated with the vendor.

Show addresses attributes
created_atstringnullable

The ISO 8601 timestamp that the vendor was created.

updated_atstringnullable

The ISO 8601 timestamp that the vendor was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example Vendor Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "status": "active",
  "contact_name": "Eric Yu",
  "currency_code": "USD",
  "email": "eric@rutter.com",
  "phone": "1234567890",
  "registration_number": "123456789",
  "tax_number": "12-3456789",
  "vendor_name": "Rutter",
  "website": "https://rutter.com",
  "subsidiaries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "primary": true
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "primary": false
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "primary": false
    }
  ],
  "addresses": [
    {
      "type": "billing",
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "country": "USA",
      "postal_code": "94110",
      "region": "CA"
    }
  ],
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Vendors

GET /versioned/accounting/vendors
Supported for: Dynamics 365ExactFreeAgentFreshBooksKashFlowMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctXeroZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    connectionobject
    Show connection attributes
    vendorsarray
    Show vendors attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "vendors": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "status": "active",
      "contact_name": "Eric Yu",
      "currency_code": "USD",
      "email": "eric@rutter.com",
      "phone": "1234567890",
      "registration_number": "123456789",
      "tax_number": "12-3456789",
      "vendor_name": "Rutter",
      "website": "https://rutter.com",
      "subsidiaries": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "primary": true
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "primary": false
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "primary": false
        }
      ],
      "addresses": [
        {
          "type": "billing",
          "address1": "123 Rutter Road",
          "address2": "Floor 4",
          "city": "San Francisco",
          "country": "USA",
          "postal_code": "94110",
          "region": "CA"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Vendor

GET /versioned/accounting/vendors/:id
Supported for: Dynamics 365ExactFreeAgentFreshBooksKashFlowMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctXeroZoho Books

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    vendorobject
    Show vendor attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "vendor": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "status": "active",
    "contact_name": "Eric Yu",
    "currency_code": "USD",
    "email": "eric@rutter.com",
    "phone": "1234567890",
    "registration_number": "123456789",
    "tax_number": "12-3456789",
    "vendor_name": "Rutter",
    "website": "https://rutter.com",
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": true
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      }
    ],
    "addresses": [
      {
        "type": "billing",
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "country": "USA",
        "postal_code": "94110",
        "region": "CA"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Create a Vendor

POST /versioned/accounting/vendors
Supported for: Dynamics 365ExactFreeAgentKashFlowMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctXeroZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    vendorobject
    Show vendor attributes

Response Body

    Any of:

    vendorobject
    Show vendor attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "vendor": {
    "contact_name": "Eric Yu",
    "currency_code": "USD",
    "vendor_name": "Rutter",
    "email": "eric@rutter.com",
    "phone": "1234567890",
    "registration_number": "123456789",
    "tax_number": "12-3456789",
    "website": "https://rutter.com",
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": true
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      }
    ],
    "addresses": [
      {
        "type": "billing",
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "country": "USA",
        "postal_code": "94110",
        "region": "CA"
      }
    ]
  }
}
Example Response Body
{
  "vendor": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "status": "active",
    "contact_name": "Eric Yu",
    "currency_code": "USD",
    "email": "eric@rutter.com",
    "phone": "1234567890",
    "registration_number": "123456789",
    "tax_number": "12-3456789",
    "vendor_name": "Rutter",
    "website": "https://rutter.com",
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": true
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      }
    ],
    "addresses": [
      {
        "type": "billing",
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "country": "USA",
        "postal_code": "94110",
        "region": "CA"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}