Vendor

Get vendor

Retrieves a vendor's details, including enrichment status and payment acceptance info when available.

get/Vendor/{idVendor}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Vendor/{idVendor}
  • Auth: HTTP bearer

Path parameters

idVendorinteger required

Vendor ID.

Response

Success

VendorNumberstring required

Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.

Name1string required
Name2string nullable required
EINstring required

Business EIN or tax ID. This value is masked in API responses.

Phonestring nullable required
Emailstring email required

Email address.

RemitEmailstring email required

Remittance email address. Used for sending virtual cards and other information about payouts.

Address1string nullable required

The address.

Address2string nullable required

Additional line for the address.

Citystring nullable required

The city.

Statestring nullable required

The state or province.

Zipstring required

ZIP code for address.

Countrystring nullable required
Mccstring required

Business Merchant Category Code (MCC). This resource lists MCC codes.

LocationCodestring nullable required
PaymentMethodstring required

The vendor's preferred payment method. Can be one of:

  • managed — Managed payment method
  • vcard — Virtual card payment method
  • check — Check payment method
  • ach — ACH payment method
VendorStatusinteger required

Vendor's status. Allowed values:

  • 0 Inactive
  • 1 Active
  • -99 Deleted
VendorIdinteger required

Payabli identifier for vendor record.

EnrollmentStatusstring required

Enrollment status of vendor in payables program.

PaypointLegalnamestring required

Business legal name.

PaypointIdinteger nullable required

The paypoint's ID. This is different from the entryname.

PaypointDbanamestring required

The alternate or common name that this business is doing business under, usually referred to as a DBA name.

PaypointEntrynamestring required

The entrypoint identifier.

ParentOrgNamestring required

The name of the parent organization.

ParentOrgIdinteger required

The ID of the org's parent organization.

CreatedDatestring date-time required

Timestamp of when record was created, in UTC.

LastUpdatedstring date-time required

Timestamp of when record was last updated, in UTC.

remitAddress1string required

Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.

For a PO Box address, include only the PO Box in this field, for example PO Box 29652. Put the rest of the address, such as a department number, in remitAddress2.

remitAddress2string required

Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.

For a PO Box address, this field holds the part of the address that follows the PO Box, for example Dept# 880662.

remitCitystring required

Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.

remitStatestring required

Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian province abbreviation.

remitZipstring required

Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits or ZIP+4 format.

remitCountrystring required

Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.

payeeName1string required

Alternative name used to receive paper check.

payeeName2string required

Alternative name used to receive paper check.

customField1string nullable required
customField2string nullable required
customerVendorAccountstring nullable required
InternalReferenceIdinteger required

An internal reference ID.

PaymentPortalUrlstring nullable required

URL for the vendor's online payment portal, if known. Populated by the vendor enrichment pipeline.

CardAcceptedstring nullable required

Whether the vendor accepts card payments. Values are yes, no, or unable to determine. Populated by the vendor enrichment pipeline.

AchAcceptedstring nullable required

Whether the vendor accepts ACH payments. Values are yes, no, or unable to determine. Populated by the vendor enrichment pipeline.

CheckAcceptedstring nullable required

Whether the vendor accepts check payments. Values are yes, no, or unable to determine. Populated by the vendor enrichment pipeline.

EnrichmentStatusstring required

Current enrichment state of the vendor. Values are not_enriched, partially_enriched, fully_enriched, or fallback_applied.

EnrichedBystring nullable required

Which enrichment method resolved the vendor's payment acceptance info. Values are invoice_scan, web_search, vendor_network, or manual.

EnrichedAtstring date-time nullable required

When the vendor was last enriched (UTC).

EnrichmentIdstring nullable required

Identifier for the enrichment request that last updated this vendor.

additionalDataAdditionalDataMap required

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Max length for a value is 100 characters.

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
externalPaypointIDstring required

A custom identifier for the paypoint, if applicable.

Changes

No recorded changes to this operation across all 1 revision of this API.