Partial Update Counterparty

patch deprecated

https://api.finexio-stage.com/v2/counterparties/{id}/

Partially update an existing counterparty

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

name

string

length ≤ 100

max length = 100 Counterpary's name

address_1

string

length ≤ 40

max length = 40 Required when payment_method is PrintedCheck

address_2

string

length ≤ 40

max length = 40

city

string

length ≤ 40

max length = 40 Required when payment_method is PrintedCheck

state

string

enum

Required when payment_method is PrintedCheck

zipcode

string

length ≤ 10

max length = 10 Required when payment_method is PrintedCheck

country

string

enum

Defaults to USA

Country.

Allowed:

primary_contact_email

string

length ≤ 50

max length = 50

remit_email

string

length ≤ 50

Required if payment_method is Card/ACH or payment_method is PrintedCheck and country is CAN.

primary_contact_name

string

length ≤ 40

max length = 40

primary_contact_phone

string

length ≤ 16

max length = 16

bank_account_number

string

length ≤ 17

max length = 17 required when payment_method is ACH or Wire Update allowed only with permission.

bank_routing_number

string

length ≤ 9

max length = 9 required when payment_method is ACH or Wire Update allowed only with permission.

payment_method

string

enum

accepts one of these values: [ 'ACH', 'Card', 'PrintedCheck', 'Wire' ]. Default ACH if no value specified. Update allowed only with permission.

Allowed:

internal_id

string

length ≤ 100

max length = 100. Secondary identifier for this counterparty. This value must be unique for counterparty type.

payment_terms

integer

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

tax_id

string

length ≤ 11

max length = 11

ineligible_for_conversion

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.

twelve_month_payment_count

integer

twelve_month_spend

number

business_type

string

enum

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

notes

string

length ≤ 1000

max length = 1000. Optional information about supplier.

Responses

200Success

400Bad Request

404Not Found