Retrieve Vendor

GET 
/accounting/vendors/:id

Retrieve a Vendor with the given id.

Request

Path Parameters

id stringrequired

The ID of the vendor.

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

vendor

object

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)

{
  "vendor": {
    "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

{
  "vendor": {
    "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...