List Vendors

GET 
/accounting/vendors

Returns a list of Vendors.

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

remoteId string

Used to filter vendors with this third-party application ID.

vendorName string

Used to filter vendors with the exact vendor name.

vendorNameContains string

Used to filter vendors whose vendor names contain the provided value.

vendorNameNotEquals string

Used to filter vendors whose vendor name to exclude.

email string

Used to filter company info with the exact vendor email.

emailContains string

Used to filter vendors whose vendor emails contain the provided value.

emailNotEquals string

Used to filter vendors whose vendor email to exclude

taxNumber string

Used to filter vendors with the exact tax number.

taxNumberContains string

Used to filter vendors whose tax numbers contain the provided value.

taxNumberNotEquals string

Used to filter vendors whose tax number to exclude.

vendorStatus string

Used to filter company info with the exact vendor status.

currency string

Used to filter vendors with the exact currency.

companyId string

Used to filter vendors with this company ID.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

vendors

object[]

Array [

id string

remoteId string

vendorName string

email

taxNumber

vendorStatus string

currency string

companyId

addresses

object[]

Array [

zipCode string

street1 string

state string

city string

addressType string

countrySubdivision string

]

phoneNumbers

object[]

Array [

phoneNumberType string

phoneNumber string

]

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

]

Example (from schema)

{
  "vendors": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "remoteId": "41",
      "vendorName": "Hicks Hardware",
      "email": {},
      "taxNumber": {},
      "vendorStatus": "ACTIVE",
      "currency": "USD",
      "companyId": {},
      "addresses": [
        {
          "zipCode": "94303",
          "street1": "42 Main St.",
          "state": "CA",
          "city": "Middlefield",
          "addressType": "Billing",
          "countrySubdivision": "CA"
        }
      ],
      "phoneNumbers": [
        {
          "phoneNumberType": "Primary",
          "phoneNumber": "(650) 554-1973"
        }
      ],
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z"
    }
  ]
}

Result

{
  "vendors": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "remoteId": "41",
      "vendorName": "Hicks Hardware",
      "email": null,
      "taxNumber": null,
      "vendorStatus": "ACTIVE",
      "currency": "USD",
      "companyId": null,
      "addresses": [
        {
          "zipCode": "94303",
          "street1": "42 Main St.",
          "state": "CA",
          "city": "Middlefield",
          "addressType": "Billing",
          "countrySubdivision": "CA"
        }
      ],
      "phoneNumbers": [
        {
          "phoneNumberType": "Primary",
          "phoneNumber": "(650) 554-1973"
        },
        {
          "phoneNumberType": "Mobile",
          "phoneNumber": "(650) 445-6666"
        }
      ],
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z"
    }
  ]
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...