action apideck_suppliers_add { label: "Create Supplier" description: "Create Supplier" provider: apideck method: POST path: "/accounting/suppliers" encoding: json input: { type: "object" properties: { account: { type: "object" properties: { code: { type: "string" description: "The code assigned to the account." } id: { type: "string" description: "The unique identifier for the account." } name: { type: "string" description: "The name of the account." } nominal_code: { type: "string" description: "The nominal code of the account." } } } addresses: { type: "array" items: { type: "object" properties: { city: { type: "string" description: "Name of city." } contact_name: { type: "string" } country: { type: "string" description: "country code according to ISO 3166-1 alpha-2." } county: { type: "string" description: "Address field that holds a sublocality, such as a county" } email: { type: "string" } fax: { type: "string" } id: { type: "string" } latitude: { type: "string" } line1: { type: "string" description: "Line 1 of the address e.g. number, street, suite, apt #, etc." } line2: { type: "string" description: "Line 2 of the address" } line3: { type: "string" description: "Line 3 of the address" } line4: { type: "string" description: "Line 4 of the address" } longitude: { type: "string" } name: { type: "string" } phone_number: { type: "string" } postal_code: { type: "string" description: "Zip code or equivalent." } row_version: { type: "string" description: "A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object." } salutation: { type: "string" } state: { type: "string" description: "Name of state" } street_number: { type: "string" description: "Street number" } string: { type: "string" } type: { type: "string" enum: ["primary", "secondary", "home", "office", "shipping", "billing", "other"] } website: { type: "string" } } additionalProperties: false } } bank_accounts: { type: "array" items: { type: "object" properties: { account_name: { type: "string" description: "The name which you used in opening your bank account." } account_number: { type: "string" description: "A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number." } account_type: { type: "string" description: "The type of bank account." enum: ["bank_account", "credit_card", "other"] } bank_code: { type: "string" description: "A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions." } bic: { type: "string" } branch_identifier: { type: "string" description: "A branch identifier is a unique identifier for a branch of a bank or financial institution." } bsb_number: { type: "string" description: "A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution." } currency: { type: "string" description: "Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)." enum: ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "ETH"] } iban: { type: "string" } } additionalProperties: false } } company_name: { type: "string" description: "The name of the company." } created_at: { type: "string" format: "date-time" description: "The date and time when the object was created." } created_by: { type: "string" description: "The user who created the object." } currency: { type: "string" description: "Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)." enum: ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "ETH"] } display_id: { type: "string" description: "Display ID" } display_name: { type: "string" description: "Display name" } downstream_id: { type: "string" description: "The third-party API ID of original entity" } emails: { type: "array" items: { type: "object" required: ["email"] properties: { email: { type: "string" format: "email" } id: { type: "string" } type: { type: "string" enum: ["primary", "secondary", "work", "personal", "billing", "other"] } } additionalProperties: false } } first_name: { type: "string" description: "The first name of the person." } id: { type: "string" description: "A unique identifier for an object." } individual: { type: "boolean" description: "Is this an individual or business supplier" } last_name: { type: "string" description: "The last name of the person." } middle_name: { type: "string" description: "Middle name of the person." } notes: { type: "string" description: "Some notes about this supplier" } phone_numbers: { type: "array" items: { type: "object" required: ["number"] properties: { area_code: { type: "string" } country_code: { type: "string" } extension: { type: "string" } id: { type: "string" } number: { type: "string" } type: { type: "string" enum: ["primary", "secondary", "home", "work", "office", "mobile", "assistant", "fax", "direct-dial-in", "personal", "other"] } } additionalProperties: false } } raw: { type: "boolean" } row_version: { type: "string" description: "A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object." } status: { type: "string" description: "Supplier status" enum: ["active", "inactive", "archived", "gdpr-erasure-request", "unknown"] } suffix: { type: "string" } tax_number: { type: "string" } tax_rate: { type: "object" properties: { code: { type: "string" description: "Tax rate code" } id: { type: "string" description: "The ID of the object." } name: { type: "string" description: "Name of the tax rate" } rate: { type: "number" description: "Rate of the tax rate" } } } title: { type: "string" description: "The job title of the person." } updated_at: { type: "string" format: "date-time" description: "The date and time when the object was last updated." } updated_by: { type: "string" description: "The user who last updated the object." } websites: { type: "array" items: { type: "object" required: ["url"] properties: { id: { type: "string" } type: { type: "string" enum: ["primary", "secondary", "work", "personal", "other"] } url: { type: "string" } } additionalProperties: false } } "x-apideck-app-id": { type: "string" } "x-apideck-consumer-id": { type: "string" } "x-apideck-service-id": { type: "string" } } required: ["id", "x-apideck-app-id", "x-apideck-consumer-id"] additionalProperties: false } output: { type: "object" required: ["data", "operation", "resource", "service", "status", "status_code"] properties: { data: { type: "object" required: ["id"] properties: { id: { type: "string" description: "The unique identifier of the resource" } } } operation: { type: "string" description: "Operation performed" } resource: { type: "string" description: "Unified API resource name" } service: { type: "string" description: "Apideck ID of service provider" } status: { type: "string" description: "HTTP Response Status" } status_code: { type: "integer" description: "HTTP Response Status Code" } } } }