# Get vendor

GET https://api-sandbox.payabli.com/api/Vendor/{idVendor}

Retrieves a vendor's details.

Reference: https://docs.payabli.com/developers/api-reference/vendor/get-vendor

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get vendor
  version: endpoint_vendor.GetVendor
paths:
  /Vendor/{idVendor}:
    get:
      operationId: get-vendor
      summary: Get vendor
      description: Retrieves a vendor's details.
      tags:
        - - subpackage_vendor
      parameters:
        - name: idVendor
          in: path
          description: Vendor ID.
          required: true
          schema:
            type: integer
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:VendorQueryRecord'
components:
  schemas:
    type_:AdditionalData:
      type: object
      additionalProperties:
        type: object
        additionalProperties:
          description: Any type
    type_:AddressNullable:
      type: string
    type_:AddressAddtlNullable:
      type: string
    type_:BankName:
      type: string
    type_:RoutingAccount:
      type: string
    type_:AccountNumber:
      type: string
    type_:TypeAccount:
      type: string
      enum:
        - value: Checking
        - value: Savings
    type_:BankAccountHolderName:
      type: string
    type_:BankAccountHolderType:
      type: string
      enum:
        - value: Personal
        - value: Business
    type_:BillingDataResponse:
      type: object
      properties:
        id:
          type: integer
          description: The bank's ID in Payabli.
        accountId:
          description: Any type
        nickname:
          type: string
        bankName:
          $ref: '#/components/schemas/type_:BankName'
        routingAccount:
          $ref: '#/components/schemas/type_:RoutingAccount'
        accountNumber:
          $ref: '#/components/schemas/type_:AccountNumber'
        typeAccount:
          $ref: '#/components/schemas/type_:TypeAccount'
        bankAccountHolderName:
          $ref: '#/components/schemas/type_:BankAccountHolderName'
        bankAccountHolderType:
          $ref: '#/components/schemas/type_:BankAccountHolderType'
        bankAccountFunction:
          type: integer
          description: >-
            Describes whether the bank account is used for deposits or
            withdrawals in Payabli:
              - `0`: Deposit
              - `1`: Withdrawal 
              - `2`: Deposit and withdrawal
        verified:
          type: boolean
        status:
          type: integer
        services:
          type: array
          items:
            description: Any type
        default:
          type: boolean
      required:
        - id
        - nickname
        - bankName
        - routingAccount
        - accountNumber
        - typeAccount
        - bankAccountHolderName
        - bankAccountHolderType
        - bankAccountFunction
        - verified
        - status
        - services
        - default
    type_:CityNullable:
      type: string
    type_:Email:
      type: string
      format: email
    type_:ContactsResponse:
      type: object
      properties:
        ContactEmail:
          $ref: '#/components/schemas/type_:Email'
          description: Contact email address.
        ContactName:
          type: string
          description: Contact name.
        ContactPhone:
          type: string
          description: Contact phone number.
        ContactTitle:
          type: string
          description: Contact title.
    type_:CreatedAt:
      type: string
      format: date-time
    type_:Ein:
      type: string
    type_:EnrollmentStatus:
      type: string
    type_:ExternalPaypointId:
      type: string
    type_:InternalReferenceId:
      type: integer
      format: int64
    type_:LastModified:
      type: string
      format: date-time
    type_:Mcc:
      type: string
    type_:OrgParentName:
      type: string
    type_:OrgParentId:
      type: integer
      format: int64
    type_:PayeeName:
      type: string
    type_:VendorPaymentMethodString:
      type: string
    type_:Dbaname:
      type: string
    type_:Entrypointfield:
      type: string
    type_:Legalname:
      type: string
    type_:Remitaddress1:
      type: string
    type_:Remitaddress2:
      type: string
    type_:Remitcity:
      type: string
    type_:Remitcountry:
      type: string
    type_:RemitEmail:
      type: string
      format: email
    type_:Remitstate:
      type: string
    type_:Remitzip:
      type: string
    type_:StateNullable:
      type: string
    type_:VendorResponseStoredMethod:
      type: object
      properties:
        IdPmethod:
          type:
            - string
            - 'null'
        Method:
          type:
            - string
            - 'null'
        Descriptor:
          type:
            - string
            - 'null'
        MaskedAccount:
          type:
            - string
            - 'null'
        ExpDate:
          type:
            - string
            - 'null'
        HolderName:
          type:
            - string
            - 'null'
        AchSecCode:
          type:
            - string
            - 'null'
        AchHolderType:
          type:
            - string
            - 'null'
        IsValidatedACH:
          type:
            - boolean
            - 'null'
        BIN:
          type:
            - string
            - 'null'
        binData:
          type:
            - string
            - 'null'
        ABA:
          type:
            - string
            - 'null'
        PostalCode:
          type:
            - string
            - 'null'
        MethodType:
          type:
            - string
            - 'null'
        LastUpdated:
          type:
            - string
            - 'null'
          format: date-time
        CardUpdatedOn:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - IdPmethod
        - Method
        - Descriptor
        - MaskedAccount
        - ExpDate
        - HolderName
        - AchSecCode
        - AchHolderType
        - IsValidatedACH
        - BIN
        - binData
        - ABA
        - PostalCode
        - MethodType
        - LastUpdated
        - CardUpdatedOn
    type_:VendorSummary:
      type: object
      properties:
        ActiveBills:
          type: integer
        PendingBills:
          type: integer
        InTransitBills:
          type: integer
        PaidBills:
          type: integer
        OverdueBills:
          type: integer
        ApprovedBills:
          type: integer
        DisapprovedBills:
          type: integer
        TotalBills:
          type: integer
        ActiveBillsAmount:
          type: number
          format: double
        PendingBillsAmount:
          type: number
          format: double
        InTransitBillsAmount:
          type: number
          format: double
        PaidBillsAmount:
          type: number
          format: double
        OverdueBillsAmount:
          type: number
          format: double
        ApprovedBillsAmount:
          type: number
          format: double
        DisapprovedBillsAmount:
          type: number
          format: double
        TotalBillsAmount:
          type: number
          format: double
    type_:Vendorid:
      type: integer
    type_:VendorNumber:
      type: string
    type_:Vendorstatus:
      type: integer
    type_:Zip:
      type: string
    type_:VendorQueryRecord:
      type: object
      properties:
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalData'
        Address1:
          $ref: '#/components/schemas/type_:AddressNullable'
        Address2:
          $ref: '#/components/schemas/type_:AddressAddtlNullable'
        BillingData:
          $ref: '#/components/schemas/type_:BillingDataResponse'
        City:
          $ref: '#/components/schemas/type_:CityNullable'
        Contacts:
          $ref: '#/components/schemas/type_:ContactsResponse'
        Country:
          type: string
        CreatedDate:
          $ref: '#/components/schemas/type_:CreatedAt'
        customerVendorAccount:
          type: string
        customField1:
          type: string
        customField2:
          type: string
        EIN:
          $ref: '#/components/schemas/type_:Ein'
        Email:
          $ref: '#/components/schemas/type_:Email'
        EnrollmentStatus:
          $ref: '#/components/schemas/type_:EnrollmentStatus'
        externalPaypointID:
          $ref: '#/components/schemas/type_:ExternalPaypointId'
        InternalReferenceId:
          $ref: '#/components/schemas/type_:InternalReferenceId'
        LastUpdated:
          $ref: '#/components/schemas/type_:LastModified'
        LocationCode:
          type: string
        Mcc:
          $ref: '#/components/schemas/type_:Mcc'
        Name1:
          type: string
        Name2:
          type: string
        ParentOrgName:
          $ref: '#/components/schemas/type_:OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/type_:OrgParentId'
        payeeName1:
          $ref: '#/components/schemas/type_:PayeeName'
        payeeName2:
          $ref: '#/components/schemas/type_:PayeeName'
        PaymentMethod:
          $ref: '#/components/schemas/type_:VendorPaymentMethodString'
        PaypointDbaname:
          $ref: '#/components/schemas/type_:Dbaname'
        PaypointEntryname:
          $ref: '#/components/schemas/type_:Entrypointfield'
        PaypointLegalname:
          $ref: '#/components/schemas/type_:Legalname'
        Phone:
          type: string
        remitAddress1:
          $ref: '#/components/schemas/type_:Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/type_:Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/type_:Remitcity'
        remitCountry:
          $ref: '#/components/schemas/type_:Remitcountry'
        RemitEmail:
          $ref: '#/components/schemas/type_:RemitEmail'
        remitState:
          $ref: '#/components/schemas/type_:Remitstate'
        remitZip:
          $ref: '#/components/schemas/type_:Remitzip'
        State:
          $ref: '#/components/schemas/type_:StateNullable'
        StoredMethods:
          type: array
          items:
            $ref: '#/components/schemas/type_:VendorResponseStoredMethod'
        Summary:
          $ref: '#/components/schemas/type_:VendorSummary'
        VendorId:
          $ref: '#/components/schemas/type_:Vendorid'
        VendorNumber:
          $ref: '#/components/schemas/type_:VendorNumber'
        VendorStatus:
          $ref: '#/components/schemas/type_:Vendorstatus'
        Zip:
          $ref: '#/components/schemas/type_:Zip'

```

## SDK Code Examples

```python GetVendor
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.vendor.get_vendor(
    id_vendor=1,
)

```

```typescript GetVendor
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.vendor.getVendor(1);

```

```go GetVendor
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Vendor.GetVendor(
	context.TODO(),
	1,
)

```

```csharp GetVendor
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Vendor.GetVendorAsync(1);

```

```ruby GetVendor
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Vendor/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java GetVendor
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Vendor/1")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php GetVendor
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Vendor/1', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift GetVendor
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Vendor/1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```