| Name | Description |
|---|---|
| Root | The top level document |
| Address | A physical location. |
| Attachment | A file attachment |
| User | A person with an account on a related system. |
| Organization | A company, legal entity, or individual |
| NativeReferenceNumber | A raw reference number value received from a source system. This document is meant to relay a platform's native reference number values in as close to the native format as possible and should not be utilized for any business logic purposes. If a reference number is required for any business logic aside from passing through reference number values, it should be added as an actual property to a canonical document. |
| Role | The role that the organization plays in the controlling company's supply chain. |
| Name | Data Type | Description | Required |
|---|---|---|---|
doc_type | String | Always chainio_purchase_order | |
organizations | Array<Organization> | Array of organizations | |
version | String | The version of the specification being used. |
| Name | Data Type | Description | Required |
|---|---|---|---|
address_1 | String | The first line of the address. | |
address_2 | String | The second line of the address. | |
address_type | String | The type of address represented by this element. Specific types may be defined on a per specification basis | |
city | String | The city. | |
country | String | The 2-Digit ISO 3166 Alpha-2 Country Code. Like 'US' | |
country_name | String | The full name of the country like “United States” | |
name | String | The name associated with the address. | |
phone_number | String | The contact phone number | |
postal_code | String | The postal or ZIP code. | |
state | String | The state, province, or administrative division code | |
state_name | String | The full name of the state, province, or administrative division. | |
unlocode | String | The UN/LOCODE associated with the address. Like 'USCHI' |
| Name | Data Type | Description | Required |
|---|---|---|---|
content | Base64 | A Base64 encoded string of the file content | |
created_at | Date | The timestamp this document was attached. | |
created_by | User | The user account / party responsible for adding the attachment. | |
file_name | String | The name of the file | |
file_type_code | String | A short code representing the logical type of file. (You might use 'INV' for an invoice.) | |
file_type_description | String | A descriptive file type like 'Invoice to customer X' | |
media_type | String | The Media Type of the file (also known as MIME Type or Content-Type) | |
memo | String | Information regarding the contents of the file. | |
private | Boolean | If true, attachment is considered a private attachment. |
| Name | Data Type | Description | Required |
|---|---|---|---|
email | String | User's email address. | |
first_name | String | User's first name. | |
last_name | String | User's last name. | |
username | String | User's account in the related system. |
| Name | Data Type | Description | Required |
|---|---|---|---|
addresses | Array<Address> | Addresses related to the organization. | |
attachments | Array<Attachment> | Attachments associated with the org. | |
bond_established | Boolean | Does the organization have an active bond established? | |
credit_hold | Boolean | Is the organization currently on credit hold? | |
credit_terms | String | Credit terms established between organization and the controlling company. | |
denied_party_screened | String | Has a denied party screening been performed for this organization? | |
organization_name | String | The name of the organization | |
roles | Array<Role> | The roles that this organization performs in relation to the company for which the document is being processed. | |
scac_code | String | The Standard Alpha Carrier Code for the organization if it is a carrier. | |
source_system_id | String | A unique identifying code from the system of record for this organization. | YES |
tax_identifier | String | Organization's legal tax identification code. |
| Name | Data Type | Description | Required |
|---|---|---|---|
code | String | A code identifying the type of reference number (ex. EDIREF, PO2, ). | |
description | String | A plain-text description of the reference number code. (ex. "EDI Reference Number", "Secondard PO Number"). | |
value | String | The reference number value. | |
value_context | String | Provides additional contextual hints at the type or classification of data present in the reference's value. |