Codat Get Create Update Suppliers Model Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "get-create-update-suppliers-model",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/options/suppliers",
"summary": "Get create/update supplier model",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Exact (Netherlands)",
"example": {
"type": "Object",
"displayName": "Supplier",
"description": "A Supplier is a person or organisation that provides a product or service",
"properties": {
"supplierName": {
"type": "String",
"displayName": "Supplier Name",
"description": "The name for the supplier, typically a company name",
"required": true
},
"emailAddress": {
"type": "String",
"displayName": "Email Address",
"description": "The preferred email address the supplier should be contacted on",
"required": false
},
"phone": {
"type": "String",
"displayName": "Phone",
"description": "The preferred phone number the supplier should be contacted on",
"required": false
},
"defaultCurrency": {
"type": "String",
"displayName": "Default Currency",
"description": "The default currency for transactions recorded against the supplier",
"required": false
},
"registrationNumber": {
"type": "String",
"displayName": "Registration Number",
"description": "The supplier's registration number",
"required": false,
"validation": {
"warnings": [
{
"field": "RegistrationNumber",
"details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length"
}
],
"information": []
}
},
"taxNumber": {
"type": "String",
"displayName": "Tax Number",
"description": "The supplier's tax number",
"required": false
},
"contactName": {
"type": "String",
"displayName": "Contact Name",
"description": "The name of the main contact for the supplier",
"required": false
},
"addresses": {
"type": "Array",
"displayName": "Addresses",
"description": "A collection of addresses associated to the supplier",
"properties": {
"country": {
"type": "String",
"displayName": "Country",
"description": "The country for the address",
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses.Country",
"details": "Must be a 2-letter country code"
}
],
"information": []
}
},
"line1": {
"type": "String",
"displayName": "Line 1",
"description": "The first line of the address",
"required": false
},
"line2": {
"type": "String",
"displayName": "Line 2",
"description": "The second line of the address",
"required": false
},
"region": {
"type": "String",
"displayName": "Region",
"description": "The fourth line of the address, or region",
"required": false
},
"city": {
"type": "String",
"displayName": "City",
"description": "The third line of the address, or city",
"required": false
},
"postalCode": {
"type": "String",
"displayName": "Postal/Zip Code",
"description": "The postal (or zip) code for the address",
"required": false
}
},
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses",
"details": "Only the first address provided will be considered, all other entries will be not be recorded"
}
]
}
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Exact (UK)",
"example": {
"type": "Object",
"displayName": "Supplier",
"description": "A Supplier is a person or organisation that provides a product or service",
"properties": {
"supplierName": {
"type": "String",
"displayName": "Supplier Name",
"description": "The name for the supplier, typically a company name",
"required": true
},
"emailAddress": {
"type": "String",
"displayName": "Email Address",
"description": "The preferred email address the supplier should be contacted on",
"required": false
},
"phone": {
"type": "String",
"displayName": "Phone",
"description": "The preferred phone number the supplier should be contacted on",
"required": false
},
"defaultCurrency": {
"type": "String",
"displayName": "Default Currency",
"description": "The default currency for transactions recorded against the supplier",
"required": false
},
"registrationNumber": {
"type": "String",
"displayName": "Registration Number",
"description": "The supplier's registration number",
"required": false,
"validation": {
"warnings": [
{
"field": "RegistrationNumber",
"details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length"
}
],
"information": []
}
},
"taxNumber": {
"type": "String",
"displayName": "Tax Number",
"description": "The supplier's tax number",
"required": false
},
"contactName": {
"type": "String",
"displayName": "Contact Name",
"description": "The name of the main contact for the supplier",
"required": false
},
"addresses": {
"type": "Array",
"displayName": "Addresses",
"description": "A collection of addresses associated to the supplier",
"properties": {
"country": {
"type": "String",
"displayName": "Country",
"description": "The country for the address",
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses.Country",
"details": "Must be a 2-letter country code"
}
],
"information": []
}
},
"line1": {
"type": "String",
"displayName": "Line 1",
"description": "The first line of the address",
"required": false
},
"line2": {
"type": "String",
"displayName": "Line 2",
"description": "The second line of the address",
"required": false
},
"region": {
"type": "String",
"displayName": "Region",
"description": "The fourth line of the address, or region",
"required": false
},
"city": {
"type": "String",
"displayName": "City",
"description": "The third line of the address, or city",
"required": false
},
"postalCode": {
"type": "String",
"displayName": "Postal/Zip Code",
"description": "The postal (or zip) code for the address",
"required": false
}
},
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses",
"details": "Only the first address provided will be considered, all other entries will be not be recorded"
}
]
}
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "FreeAgent",
"example": {
"type": "Object",
"displayName": "Supplier",
"description": "A Supplier is a person or organisation that provides a product or service",
"properties": {
"supplierName": {
"type": "String",
"displayName": "Supplier Name",
"description": "The name for the supplier, typically a company name",
"required": true
},
"status": {
"type": "String",
"displayName": "Supplier Status",
"description": "The current state of the supplier",
"options": [
{
"value": "Active",
"type": "String",
"displayName": "Active",
"required": false
},
{
"value": "Archived",
"type": "String",
"displayName": "Archived",
"required": false
}
],
"required": true
},
"addresses": {
"type": "Array",
"displayName": "Addresses",
"description": "A collection of addresses associated to the supplier",
"properties": {
"line1": {
"type": "String",
"displayName": "Line 1",
"description": "The first line of the address",
"required": true
},
"line2": {
"type": "String",
"displayName": "Line 2",
"description": "The second line of the address",
"required": false
},
"city": {
"type": "String",
"displayName": "City",
"description": "The third line of the address, or city",
"required": false
},
"region": {
"type": "String",
"displayName": "Region",
"description": "The fourth line of the address, or region",
"required": false
},
"country": {
"type": "String",
"displayName": "Country",
"description": "The country for the address",
"required": false
},
"postalCode": {
"type": "String",
"displayName": "Postal/Zip Code",
"description": "The postal (or zip) code for the address",
"required": false
}
},
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses",
"details": "Only one address may be specified"
}
]
}
},
"contactName": {
"type": "String",
"displayName": "Contact Name",
"description": "The name of the main contact for the supplier",
"required": false
},
"emailAddress": {
"type": "String",
"displayName": "Email Address",
"description": "The preferred email address the supplier should be contacted on",
"required": false
},
"taxNumber": {
"type": "String",
"displayName": "Tax Number",
"description": "The supplier's tax number",
"required": false
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "MYOB AccountRight and Essentials",
"example": {
"type": "Object",
"displayName": "Supplier",
"description": "A Supplier is a person or organisation that provides a product or service",
"properties": {
"supplierName": {
"type": "String",
"displayName": "Supplier Name",
"description": "The name for the supplier, typically a company name",
"required": true,
"validation": {
"warnings": [
{
"field": "SupplierName",
"details": "Must not have the part after the first name longer than 30 characters."
},
{
"field": "SupplierName",
"details": "Must not have its first part (i.e. the first name) longer than 20 characters."
}
],
"information": [
{
"field": "SupplierName",
"details": "Must be provided and must contain a First and Last name separated by a ' '(space)."
}
]
}
},
"emailAddress": {
"type": "String",
"displayName": "Email Address",
"description": "The preferred email address the supplier should be contacted on",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "EmailAddress",
"details": "Must not be longer than 255 characters."
}
]
}
},
"phone": {
"type": "String",
"displayName": "Phone",
"description": "The preferred phone number the supplier should be contacted on",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Phone",
"details": "Must not be longer than 21 characters."
}
]
}
},
"taxNumber": {
"type": "String",
"displayName": "Tax Number",
"description": "The supplier's tax number",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "TaxNumber",
"details": "Must not be longer than 19 characters."
}
]
}
},
"registrationNumber": {
"type": "String",
"displayName": "Registration Number",
"description": "The supplier's registration number",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "RegistrationNumber",
"details": "Must not be longer than 14 characters."
}
]
}
},
"status": {
"type": "String",
"displayName": "Supplier Status",
"description": "The current state of the supplier",
"options": [
{
"value": "Active",
"type": "String",
"required": false
},
{
"value": "Unknown",
"type": "String",
"required": false
}
],
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "Status",
"details": "Must be provided."
}
]
}
},
"addresses": {
"type": "Array",
"displayName": "Addresses",
"description": "A collection of addresses associated to the supplier",
"properties": {
"line1": {
"type": "String",
"displayName": "Line 1",
"description": "The first line of the address",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses.Line1",
"details": "Must not be longer than 127 characters."
}
]
}
},
"line2": {
"type": "String",
"displayName": "Line 2",
"description": "The second line of the address",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses.Line2",
"details": "Must not be longer than 127 characters."
}
]
}
},
"city": {
"type": "String",
"displayName": "City",
"description": "The third line of the address, or city",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses.City",
"details": "Must not be longer than 255 characters."
}
]
}
},
"region": {
"type": "String",
"displayName": "Region",
"description": "The fourth line of the address, or region",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses.Region",
"details": "Must not be longer than 255 characters."
}
]
}
},
"postalCode": {
"type": "String",
"displayName": "Postal/Zip Code",
"description": "The postal (or zip) code for the address",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses.PostalCode",
"details": "Must not be longer than 11 characters."
}
]
}
},
"country": {
"type": "String",
"displayName": "Country",
"description": "The country for the address",
"required": false,
"validation": {
"warnings": [],
"information": [
{
"field": "Addresses.Country",
"details": "Must not be longer than 255 characters."
}
]
}
}
},
"required": true,
"validation": {
"warnings": [
{
"field": "Addresses",
"details": "Must only have 5 address entries at most."
}
],
"information": [
{
"field": "Addresses",
"details": "Must be provided."
}
]
}
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Oracle NetSuite",
"example": {
"type": "Object",
"displayName": "Supplier",
"description": "A Supplier is a person or organisation that provides a product or service",
"properties": {
"supplierName": {
"type": "String",
"displayName": "Supplier Name",
"description": "The name for the supplier, typically a company name",
"required": true
},
"emailAddress": {
"type": "String",
"displayName": "Email Address",
"description": "The preferred email address the supplier should be contacted on",
"required": false
},
"defaultCurrency": {
"type": "String",
"displayName": "Default Currency",
"description": "The default currency for transactions recorded against the supplier",
"required": false
},
"phone": {
"type": "String",
"displayName": "Phone",
"description": "The preferred phone number the supplier should be contacted on",
"required": false
},
"taxNumber": {
"type": "String",
"displayName": "Tax Number",
"description": "The supplier's tax number",
"required": false
},
"status": {
"type": "String",
"displayName": "Supplier Status",
"description": "The current state of the supplier",
"options": [
{
"value": "Active",
"type": "String",
"displayName": "Active",
"required": false
},
{
"value": "Archived",
"type": "String",
"displayName": "Archived",
"required": false
}
],
"required": true
},
"addresses": {
"type": "Array",
"displayName": "Addresses",
"description": "A collection of addresses associated to the supplier",
"properties": {
"type": {
"type": "String",
"displayName": "Address Type",
"description": "The type of the address",
"options": [
{
"value": "Billing",
"type": "String",
"displayName": "Billing",
"required": false
},
{
"value": "Delivery",
"type": "String",
"displayName": "Delivery",
"required": false
},
{
"value": "Unknown",
"type": "String",
"displayName": "Unknown",
"required": false
}
],
"required": true
},
"line1": {
"type": "String",
"displayName": "Line 1",
"description": "The first line of the address",
"required": false
},
"line2": {
"type": "String",
"displayName": "Line 2",
"description": "The second line of the address",
"required": false
},
"city": {
"type": "String",
"displayName": "City",
"description": "The third line of the address, or city",
"required": false
},
"region": {
"type": "String",
"displayName": "Region",
"description": "The fourth line of the address, or region",
"required": false
},
"country": {
"type": "String",
"displayName": "Country",
"description": "The country for the address",
"required": true,
"validation": {
"warnings": [
{
"field": "Addresses.Country",
"details": "Must be a two letter Country ISO code"
}
],
"information": []
}
},
"postalCode": {
"type": "String",
"displayName": "Postal/Zip Code",
"description": "The postal (or zip) code for the address",
"required": false
}
},
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses",
"details": "Only one each of Billing and Delivery addresses can be provided"
}
],
"information": [
{
"field": "Addresses",
"details": "Multiple addresses of Unknown type may be provided"
}
]
}
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Desktop",
"example": {
"type": "Object",
"displayName": "Supplier",
"description": "A Supplier is a person or organisation that provides a product or service",
"properties": {
"supplierName": {
"type": "String",
"displayName": "Supplier Name",
"description": "The name for the supplier, typically a company name",
"required": true,
"validation": {
"warnings": [
{
"field": "SupplierName",
"details": "Max length of 41 characters."
}
],
"information": []
}
},
"contactName": {
"type": "String",
"displayName": "Contact Name",
"description": "The name of the main contact for the supplier",
"required": false,
"validation": {
"warnings": [
{
"field": "ContactName",
"details": "Max length of 25 characters for first and last names"
}
],
"information": []
}
},
"phone": {
"type": "String",
"displayName": "Phone",
"description": "The preferred phone number the supplier should be contacted on",
"required": false
},
"emailAddress": {
"type": "String",
"displayName": "Email Address",
"description": "The preferred email address the supplier should be contacted on",
"required": false
},
"registrationNumber": {
"type": "String",
"displayName": "Registration Number",
"description": "The supplier's registration number",
"required": false
},
"taxNumber": {
"type": "String",
"displayName": "Tax Number",
"description": "The supplier's tax number",
"required": false,
"validation": {
"warnings": [
{
"field": "TaxNumber",
"details": "Max length of 30 characters."
}
],
"information": []
}
},
"defaultCurrency": {
"type": "String",
"displayName": "Default Currency",
"description": "The default currency for transactions recorded against the supplier",
"required": false,
"validation": {
"warnings": [
{
"field": "DefaultCurrency",
"details": "Must be a three letter ISO code that matches an existing, active currency in the QuickBooks Desktop company"
},
{
"field": "DefaultCurrency",
"details": "Can only be set if Multicurrency is enabled within the QuickBooks Desktop company"
}
],
"information": [
{
"field": "DefaultCurrency",
"details": "If not set, will default to the base currency of the QuickBooks Desktop company"
}
]
}
},
"status": {
"type": "String",
"displayName": "Supplier Status",
"description": "The current state of the supplier",
"options": [
{
"value": "Active",
"type": "String",
"displayName": "Active",
"required": false
},
{
"value": "Archived",
"type": "String",
"displayName": "Archived",
"required": false
}
],
"required": true
},
"addresses": {
"type": "Array",
"displayName": "Addresses",
"description": "A collection of addresses associated to the supplier",
"properties": {
"line1": {
"type": "String",
"displayName": "Line 1",
"description": "The first line of the address",
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses.Line1",
"details": "Max length of 41 characters."
}
],
"information": []
}
},
"line2": {
"type": "String",
"displayName": "Line 2",
"description": "The second line of the address",
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses.Line2",
"details": "Max length of 41 characters."
}
],
"information": []
}
},
"city": {
"type": "String",
"displayName": "City",
"description": "The third line of the address, or city",
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses.City",
"details": "Max length of 31 characters."
}
],
"information": []
}
},
"region": {
"type": "String",
"displayName": "Region",
"description": "The fourth line of the address, or region",
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses.Region",
"details": "Max length of 21 characters."
}
],
"information": []
}
},
"country": {
"type": "String",
"displayName": "Country",
"description": "The country for the address",
"required": false,
"validation": {
"warnings": [
{
"field": "Addresses.Country",
"details": "Max leng
# --- truncated at 32 KB (171 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/examples/codat-get-create-update-suppliers-model-example.json