Update Counterparty

Make full or partial updates to your suppliers

Full Updates

You can make full updates to your suppliers using the Update Counterparty endpoint (http://stage.api.finexio.com/v2/counterparties/{id}/).

Enter the unique ID (“id”) for the supplier you would like to update along with the parameters.

👍

Counterparty Unique ID (id)

The {id} can be found in the response when creating counterparties or by getting a list of counterparties.

A sample full update request

JSON

{
    "name": "Tires Supply",
    "type": "Supplier",
    "address_1": "123 Main St.",
    "city": "Orlando",
    "state": "FL",
    "zipcode": "32817",
    "country": "USA",
    "primary_contact_email": "[email protected]",
    "remit_email": "[email protected]", 
    "primary_contact_name": "Tires Supply",
    "primary_contact_phone": "407-555-1212",
    "bank_account_number": "123456789",
    "bank_routing_number": "021000021",
    "internal_id": "tiressupply",
    "twelve_month_payment_count": 12,
    "twelve_month_spend": "25.00",
    "payment_terms": 30,
    "tax_id": "123-12-2222",
    "ineligible_for_conversion": true,
    "business_type": "Business",
    "notes": "Full Update to Supplier"
}

A sample full update response

JSON

{
    "id": "b1d5a7e8-62fa-4e38-93bf-6be23bdefa82",
    "name": "Tires Supply",
    "type": "Supplier",
    "created": "2021-11-21T22:27:20.975073",
    "updated": "2021-11-21T22:27:20.975095",
    "address_1": "123 Main St.",
    "address_2": null,
    "city": "Orlando",
    "state": "FL",
    "zipcode": "32817",
    "country": "USA",
    "primary_contact_email": "[email protected]",
    "remit_email": "[email protected]",
    "primary_contact_name": "Tires Supply",
    "primary_contact_phone": "407-555-1212",
    "bank_account_number": "123456789",
    "bank_routing_number": "021000021,
    "payment_method": "PrintedCheck",
    "internal_id": "TIRESSUPPLY",
    "twelve_month_payment_count": 12,
    "twelve_month_spend": "25.00",
    "payment_terms": 30,
    "tax_id": "123-12-2222",
    "ineligible_for_conversion": true,
    "business_type": "Business",
    "notes": "Full Update to Supplier"
}

Partial Updates

Partial updates can be made using the Partial Update Counterparty endpoint (http://stage.api.finexio.com/v2/counterparties/{id}/).

Enter the unique ID (“id”) and the parameters for the supplier you would like to update.

A sample partial update request:

JSON

{
    "primary_contact_phone": "407-555-1213",
    "twelve_month_payment_count": 10,
    "twelve_month_spend": "34.00",
    "ineligible_for_conversion": true,
    "notes": "Partial Supplier updates"
}

A sample partial update response:

JSON

{
    "id": "b1d5a7e8-62fa-4e38-93bf-6be23bdefa82",
    "name": "Tires Supply",
    "type": "Supplier",
    "created": "2021-11-21T22:27:20.975073",
    "updated": "2021-11-21T22:27:20.975095",
    "address_1": "123 Main St.",
    "address_2": null,
    "city": "Orlando",
    "state": "FL",
    "zipcode": "32817",
    "country": "USA",
    "primary_contact_email": "[email protected]",
    "remit_email": "[email protected]",
    "primary_contact_name": "Tires Supply",
    "primary_contact_phone": "407-555-1213",
    "bank_account_number": "123456789",
    "bank_routing_number": "021000021,
    "payment_method": "PrintedCheck",
    "internal_id": "TIRESSUPPLY",
    "twelve_month_spend": "34.00",
    "twelve_month_payment_count": 10,
    "payment_terms": 30,
    "tax_id": null,
    "ineligible_for_conversion": true,
    "business_type": "Business",
    "notes":  "Partial Supplier updates"
}