Skip to content

Vendors

A Vendor is an entity to which an expense can be paid.

Operations

Fetching a list of Vendors

Request

This endpoint returns structured Vendor objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the vendors top-level JSON key. Please see our Response Format section for more information.

Query
archivedboolean

If True, returns all archived vendors and false returns all active vendors.

external_reference_external_messagestring

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_statusstring

Filter by the status of the external object in the external system.

external_reference_service_modelstring

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_refinteger, (int32)

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

Filter by the status of the integration, this can be successful or fail.

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: alphabetical:asc and alphabetical:desc.

Default:"alphabetical:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
without_external_reference_service_namestring

Exclude by the existence of an external reference with the specified service name.

GET
/vendors
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/vendors?archived=true&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&has_external_references=true&include=string&only=string&order=alphabetical%3Aasc&page=1&per_page=20&without_external_reference_service_name=string'

Responses

A list of Vendors have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
vendorsobject
external_referencesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "vendors": {
    "property1": {
      "archived": true,
      "external_reference_ids": [
        "string"
      ],
      "externally_managed": true,
      "in_use": true,
      "name": "string"
    },
    "property2": {
      "archived": true,
      "external_reference_ids": [
        "string"
      ],
      "externally_managed": true,
      "in_use": true,
      "name": "string"
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}