Send organization
| Name | Description |
|---|---|
| Root | Chain.io schema for an organization |
| PartyIdentifier | A code and context that can be used to uniquely identify a location. |
| Location | A single location associated with the organization. |
| PhoneNumber | A phone number and type object. |
| EmailAddress | An email address and type object. |
| Contact | A single point of contact in an organization. |
| AccountingDetails | All accounting specific details associated with how the organization is managed in the sender's system. |
| PaymentTerms | The agreed upon conditions for the debtor will remit payment and any discounts that may be provided for early repayment. |
| CustomProperties | An object an input converter can utilize to pass any custom data back into a flow that can potentially be utilized by an output converter. |
| Name | Data Type | Description | Required |
|---|---|---|---|
accounting_system_identifier | String | The 'primary key' uniquely identifying the organization in the sender's accounting system. | YES |
name | String | The entity's name. | YES |
status | String | An indicator of the location's current status in the sender's system. Allowed values: active, inactive. | |
native_organization_types | Array<String> | ||
identifiers | Array<PartyIdentifier> | All applicable identifiers that can be used to identify the organization. | |
locations | Array<Location> | All the addresses associated with the organization. | |
contacts | Array<Contact> | All the contacts associated with the organization. | |
accounting_details | Array<AccountingDetails> | All the accounting details associated with the organization. | |
custom_properties | CustomProperties | ||
created_at | DateTime | The date this record was created. | |
updated_at | DateTime | The date this record was updated. |
| Name | Data Type | Description | Required |
|---|---|---|---|
code | String | The identifier code | YES |
code_type | String | The type of data that the identifier code represents. The accounting_system_external_identifier should be included to relay the "natural" identifier of the organization used by the sender's system. Typically this would represent what some systems call an Organization Code, EDI Identifier or Company Code. Allowed values: accounting_system_external_identifier, tax_id, iata, scac, legal_entity_id, duns. | YES |
code_country | String | The 2 character ISO-3166-2 country code that the id code was issued in / by. |
| Name | Data Type | Description | Required |
|---|---|---|---|
accounting_system_identifier | String | The 'primary key' uniquely identifying the location in the sender's accounting system. | |
identifiers | Array<PartyIdentifier> | An array of all applicable identifiers that can be used to identify the location. | |
name | String | A name for the address. Typically the name of the business located at the address. | |
address_1 | String | The address' street number and name. | |
address_2 | String | The address' secondary address information. | |
city | String | The address' city component. | |
country_subdivision | String | The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data. | |
country | String | The address' 2 character ISO-3166-2 country Code. | |
postal_code | String | The unique postal code identifier for the address. | |
unlocode | String | A UN/Locode identifier associated with the address. | |
phone_numbers | Array<PhoneNumber> | All phone numbers associated directly with the location but not necessarily an individual contact at that location. For instance, this may represent the primary front desk number and a fax number. | |
email_addresses | Array<EmailAddress> | All email addresses associated directly with the location. | |
status | String | An indicator of the location's current status in the sender's system. Allowed values: active, inactive. | |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
phone_type | String | The type of phone number. Allowed values: main, mobile, work, home, fax, other. | YES |
phone_number | String | The actual phone number. When at all possible, to increase interoperability, phone numbers should be formatted according to RFC3966. Also see libphonenumber when parsing phone numbers. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
email_type | String | The type of email address. Allowed values: main, work, personal, other. | YES |
email_address | String | The email address | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
accounting_system_identifier | String | The 'primary key' uniquely identifying the contact in the sender's accounting system. | |
name | String | The full name of the contact. | |
courtesy_title | String | A title used before the contact's fullname as a professional greeting. | |
job_title | String | The contact's job title. | |
email_addresses | Array<EmailAddress> | All email addresses associated directly with the contact. | |
phone_numbers | Array<PhoneNumber> | ||
status | String | An indicator of the contact's current status in the sender's system. Allowed values: active, inactive. | |
language | String | The ISO 639-2 code identifying the primary language of the contact. | |
location_identifiers | Array<String> | The location identifiers for all the organization locations this contact is linked with. | |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
accounting_system_company_code | String | A specific sub-entity company code that these details utilized for. For systems that maintain no sub-entities or for details that are considered the default accross every company this property should not be sent. When sending or receiving invoices from/to this accounting system, this code should align with the invoice's company_code property. | |
ap | Boolean | If true, the organization is considered a vendor in the sender's accounting system and can expect to be a debtor on invoices issue by this organization. | YES |
ap_currency | String | The ISO 4217 currency code indicating the default currency the organization expects to accounting system to remit payment in. This is NOT the currency of record that the accounting system will utilize for tracking payments to this organization. | |
ap_group_code | String | The accounting system's native code that identifies the AP group this organization has been classified into. | |
ap_terms | PaymentTerms | ||
ar | Boolean | If true, the organization is considered a customer in the sender's accounting system and the sender will be listed as a creditor on invoices issued to the organization. | YES |
ar_currency | String | The ISO 4217 currency code indicating the default currency the organization expects to accounting system to billed in. This is NOT the currency of record that the accounting system will utilize for tracking payments to this organization. | |
ar_group_code | String | The accounting system's native code that identifies the AR group this organization has been classified into. | |
ar_terms | PaymentTerms | ||
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
terms | String | The terms code identifying the type of payment terms in effect. net = NET, pia = Payment In Advance, cia = Cash In Advance, cod = Cash on Delivery, pod = Payment on Delivery, mfi = Month Following Invoice, eom = End of Month Allowed values: net, pia, cia, cod, pod, mfi, eom. | YES |
terms_number | Decimal | The value used to indicate the numeric portion of the terms code. Given the terms "NET 10", this value would be 10. Given the terms "15 MFI", this value would be 15. | |
discount_number | Decimal | The value used to indicate the time period portion of a discount. Typically, this is given in the number of days. | |
discount_percentage | Decimal | The value used to indicate the overall percentage discount that will be provided for early payment. If an creditor is giving a 2.5% discount, this value should be sent as 2.5 |
| Name | Data Type | Description | Required |
|---|