A counterparty is a Buyer or a Supplier in our system. This can be an individual or a business.

Field

Description

id
string

Unique identifier for the counterparty.

name
string

Display name of the counterparty.

type
string

Type of the counterparty: Buyer or Supplier. only supplier type is allowed in case of creating a new counterparty

address_1
string

Street address of the counterparty - Address Line 1.

address_2
string

Street address of the counterparty - Address Line 2.

city
string

City of the counterparty.

state
string

State of the counterparty.

zipcode
string

Zipcode of the counterparty.

country
string

Country of the counterparty.

primary_contact_email
string

Email of primary contact person representing the counterparty.

remit_email
string

Email to be used for remit notifications.

primary_contact_name
string

Name of primary contact person.

primary_contact_phone
string

Phone of primary contact person.

bank_account_number
string

Bank account number of counterparty.

bank_routing_number
string

Bank routing number of counterparty.

payment_method
string

Preffered payment method for counterparty.

internal_id
string

Secondary identifier for this counterparty This value must be unique for counterparty type.

{
    "id": "Unique-id-of-counterparty",
   
    "name": "Finexio Inc.",
    
    "type": "Buyer",
    
    "created": "2019-02-26T20:13:46.925922",
    
    "updated": "2020-05-06T20:43:42.109670",
    
    "address_1": "Address Line 1 Here",
    
    "address_2": "Address Line 1 Here",
    
    "city": "City Name",
    
    "state": "State Code",
    
    "zipcode": "32751",
    
    "country": "USA",
    
    "primary_contact_email": "[email protected]",
    
    "remit_email": null,
    
    "primary_contact_name": "Full Name",
    
    "primary_contact_phone": "123-456-78",
    
    "bank_account_number": "1234",
    
    "bank_routing_number": "123456789",
    
    "payment_method": null,
    
    "internal_id": "FINEXIO-BUYER"
}