Partial Update Counterparty

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

Partially update an existing counterparty

See Counterparties Schema for more details.

Example Response

{
    "id": "689cedfc-6711-4020-ba69-91fa2c1f614c",
    "name": "Dev Supplier 1X",
    "type": "Supplier",
    "created": "2024-04-24T16:09:05.030000",
    "updated": "2024-04-24T16:13:34.909000",
    "address_1": "Dev address 1",
    "address_2": "",
    "city": "Dev city",
    "state": "IL",
    "zipcode": "01111",
    "country": "USA",
    "primary_contact_email": "test@finexio.com",
    "remit_email": "test@finexio.com",
    "primary_contact_name": "Dev Contact",
    "primary_contact_phone": "000111110",
    "bank_account_number": null,
    "bank_routing_number": null,
    "payment_method": "PrintedCheck",
    "internal_id": "UPDATED ID DEV",
    "twelve_month_spend": null,
    "twelve_month_payment_count": null,
    "payment_terms": 10,
    "tax_id": "",
    "ineligible_for_conversion": false,
    "business_type": null,
    "notes": "",
    "remit_data": null,
    "issue_one_disbursement_per_invoice": true
}

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

Required when payment_method is PrintedCheck

zipcode

string

length ≤ 10

max length = 10
Required when payment_method is PrintedCheck

country

string

Defaults to USA

Country.

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

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

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

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

Response body

object

string

Unique identifier

name

string

length ≤ 100

max length = 100
Counterpary's name

created

date-time

Date and time the counterparty was created

updated

date-time

Date and time the counterparty was last modified

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

Required when payment_method is PrintedCheck

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

zipcode

string

length ≤ 10

max length = 10
Required when payment_method is PrintedCheck

country

string

Defaults to USA

Country.

CAN UMI USA

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

bank_routing_number

string

length ≤ 9

max length = 9
required when payment_method is ACH or Wire

payment_method

string

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

ACH Card PrintedCheck Wire

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

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

Employee Business Individual InternalTransfer Student BankingInstitution Insurance Government Unknown

notes

string

length ≤ 1000

max length = 1000. Optional information about supplier.

Example Response

200Success

400Bad Request

404Not Found