v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

payments

Retrieve a payments Vendor

Retrieve a single accounting vendor by ID.

get/payments/vendor/{id}

Path parameters

idstring required

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Successfully retrieved

idstring

The unique identifier of the vendor.

ottimate_company_idstring

The Ottimate company ID associated with this vendor.

namestring

The vendor's business name.

erp_vendor_idstring

The vendor's unique identifier in your ERP system.

customer_account_numberstring

Your account number with this vendor.

is_ach_enrolledboolean

Whether the vendor is enrolled in ACH electronic payments.

estimated_monthly_volumeinteger

Estimated monthly payment volume to this vendor in dollars.

emailstring

The vendor's primary email address.

contact_namestring

The vendor's primary contact name.

phone_numberstring

The vendor's primary phone number.

invite_electronic_paymentsboolean

Whether the vendor has been invited to enroll in electronic payments.

address_line_1string

The first line of the vendor's mailing address.

address_line_2string

The second line of the vendor's mailing address.

citystring

The city of the vendor's mailing address.

statestring

The two-letter state code of the vendor's mailing address.

zipcodestring

The ZIP code of the vendor's mailing address.

countrystring

The two-letter ISO country code of the vendor's mailing address.

care_ofstring

The care-of name for the vendor's mailing address.

admin_emailstring

The email address of the vendor's admin contact.

admin_phonestring

The phone number of the vendor's admin contact.

admin_namestring

The name of the vendor's admin contact.

metadataPaymentsVendorIdGetResponsesContentApplicationJsonSchemaMetadata

Additional key-value metadata associated with the vendor.