API Reference

Create Supplier

post
https://api.finexio-stage.com/v2/counterparties/suppliers

Create A New Supplier

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 100

max length = 100

string
length ≤ 36

max length = 36

string
length ≤ 40

max length = 40 required only if payment_method is 'Check'

string
length ≤ 40

max length = 40

string
length ≤ 40

max length = 40 required only if payment_method is 'Check'

string
enum
length ≤ 2

accepts one of these values: [ 'AL', 'AK', 'AS', 'AZ', 'AR', 'AA', 'AE', 'AP', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'GU', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'MP', 'OH', 'OK', 'OR', 'PA', 'PR', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VI', 'VA', 'WA', 'WV', 'WI', 'WY', 'AB', 'BC', 'MB', 'NB', 'NL', 'NT', 'NS', 'NU', 'ON', 'PE', 'QC', 'SK', 'YT' ]. required only if payment_method is 'Check'

string
length ≤ 10

max length = 10 required only if payment_method is 'Check'

string
enum
Defaults to USA

accepts one of these values: [ 'CAN', 'UMI', 'USA' ]. required only if payment_method is 'Check'

Allowed:
string
length ≤ 40

max length = 40

string
length ≤ 40

max length = 40

string
length ≤ 40

max length = 40

string
enum
length ≤ 2

accepts one of these values: [ 'AL', 'AK', 'AS', 'AZ', 'AR', 'AA', 'AE', 'AP', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'GU', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'MP', 'OH', 'OK', 'OR', 'PA', 'PR', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VI', 'VA', 'WA', 'WV', 'WI', 'WY', 'AB', 'BC', 'MB', 'NB', 'NL', 'NT', 'NS', 'NU', 'ON', 'PE', 'QC', 'SK', 'YT' ]

string
length ≤ 10

max length = 10

string
enum
Defaults to USA

accepts one of these values: [ 'CAN', 'UMI', 'USA' ]. Default USA if no value specified.

Allowed:
string
length ≤ 16

max length = 16

string
required
length ≤ 200

max length = 200. Secondary identifier. This value must be unique.

string
length ≤ 11

max length = 11

contacts
array of objects
contacts
string

required only if payment_method is 'Card' and delivery_method is 'Email'.

string
length ≤ 17

max length = 17 required only if payment_method is 'ACH' or 'Wire' or 'FinexioExpress'. It can't contain non-numeric characters.

string
length ≤ 9

max length = 9 required only if payment_method is 'ACH' or 'Wire' or 'FinexioExpress'.

string
enum
required

accepts one of these values: [ 'ACH', 'Card', 'Check', 'Wire', 'FinexioExpress' ].

Allowed:
string

accepts one of these values: [ 'Mail', 'Email', 'Portal','Phone' ] and can be null. Required only if payment_method is other than ACH and Wire.

string
enum

accepts one of these values: [ 'Mail', 'Email' ].

Allowed:
integer

Allowed values: min = 0, max = 365. Payment terms is optional field. This is an integer field and represents No. of days.

boolean
Defaults to false

Supplier conversion eligibility determines if Finexio SHOULD NOT reach out to this supplier due to high sensitivity or special payment arrangements or contracted terms.

boolean
Defaults to false

Indicates if the supplier is ineligible to receive payments using Card by Mail. If true the supplier will not be offered the Card by Mail program. Defaults to false if not passed.

string
enum

Accepts one of these values: [ 'Employee', 'Business', 'Individual', 'InternalTransfer', 'Student', 'BankingInstitution', 'Insurance', 'Government', 'Unknown' ]

integer

This is related to spend data and indicates the number of payments made to that supplier over the last 12 months.

integer

This is related to spend data and indicates the total dollar amount paid to that supplier over the last 12 months.

string
length ≤ 1000

max length = 1000 Optional information about supplier.

metadata
object

Array of name/value pairs.The name can be any character string not beginning with _ with a max length of 25 characters, The value can have a max length of 100 chars and can be null.

boolean
Defaults to true

For internal use only. Defaults to true if not passed. If passed, you should always set it to true.

boolean
Defaults to false

Payments will be made by Finexio staff using the Phone or Portal delivery method.

string

Optional: Category name for supplier. Must be a valid category from the list of available categories.

string

Optional: Subcategory name for supplier. Must be a valid subcategory from the list of available subcategories, available subcategories depend on the provided category value.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Updated 9 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 9 months ago