{ "openapi": "3.1.0", "info": { "title": "Supplier Management", "version": "2023-02-28" }, "servers": [ { "url": "https://client.beeline.com/api" }, { "url": "https://client-eu.beeline.com/api" } ], "tags": [ { "name": "Supplier", "description": "Manage suppliers through retrieving, creating, and updating supplier data.\nClick [here](webhook-management_2023-07-01#tag/supplier-event-types) to see the\nlist of available supplier events that are available to subscribe to.\n" }, { "name": "Supplier Legal Entity", "description": "The Supplier Legal entity API is comprised of endpoints to retrieve and manage supplier legal entity-related data.\n" } ], "paths": { "/sites/{clientSiteId}/suppliers": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-supplier-list", "summary": "Supplier List", "description": "Returns a list of supplier organizations. Optionally, you can query for only active suppliers with the inclusion of the activeOnly parameter.", "tags": [ "Supplier" ], "security": [ { "client_auth": [ "read:supplier" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "in": "query", "name": "activeOnly", "description": "A boolean value representing whether to query for only active suppliers.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "A list of supplier organizations.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of suppliers." }, "value": { "type": "array", "description": "A list of suppliers and their organization details.", "items": { "type": "object", "description": "A supplier organization.", "required": [ "organizationId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "System-generated ID that uniquely identifies the supplier." }, "name": { "type": "string", "description": "The name of the supplier.", "example": "SupplierName" }, "organizationCode": { "type": "string", "description": "Client-defined code that uniquely identifies the supplier.", "example": "SupplierCode" }, "description": { "type": "string", "description": "A description of the supplier.", "example": "Description of the supplier" }, "billingName": { "type": "string", "description": "The billing name of the supplier.", "example": "Billing Name" }, "externalCode": { "type": "string", "description": "The external code of the supplier.", "example": "External Code" }, "active": { "type": "boolean", "description": "Indicator of the supplier's active status. True if the supplier is active. Otherwise, false.", "example": true }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.", "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.", "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.", "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.", "example": "123-456-7890" }, "mailingAddress": { "type": "object", "description": "The mailing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "billingAddress": { "type": "object", "description": "The billing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "legal": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true }, "taxMarginPercent": { "description": "The tax margin percent of the legal entity of the supplier.", "type": "number", "format": "double", "example": 0.1 } } } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "post": { "operationId": "post-create-supplier", "summary": "Create Supplier", "description": "Add a new supplier to Beeline Enterprise.\n", "tags": [ "Supplier" ], "security": [ { "client_auth": [ "write:supplier" ] } ], "requestBody": { "description": "Adds a new supplier in Beeline Enterprise.\n - This will create the initial specified object only.\n - This will NOT update a supplier.\n", "content": { "application/json": { "schema": { "type": "object", "description": "A Supplier.", "required": [ "name", "code" ], "properties": { "name": { "type": "string", "description": "The name of the supplier.\n", "maxLength": 255, "example": "SupplierName" }, "code": { "type": "string", "description": "The organization code of the supplier.\n", "maxLength": 50, "example": "SupplierCode" }, "description": { "type": "string", "description": "The description of the supplier.\n", "maxLength": 255, "example": "Description of the supplier." }, "billingName": { "type": "string", "description": "The billing name of the supplier.\n", "maxLength": 100, "example": "Billing Name." }, "externalCode": { "type": "string", "description": "The external code of the supplier.\n", "example": "External Code" }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "maxLength": 510, "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "active": { "type": "boolean", "description": "A boolean value representing the status of the supplier.\n", "example": true }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "mailingAddress": { "description": "The mailing address of the supplier.", "type": "object", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "description": "The first line of the adress, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string", "maxLength": 150 }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string", "maxLength": 150 }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string", "maxLength": 50 }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string", "maxLength": 5 }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string", "maxLength": 10 }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string", "maxLength": 255 } } }, "billingAddress": { "description": "The billing address of the supplier.", "type": "object", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "description": "The first line of the adress, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string", "maxLength": 150 }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string", "maxLength": 150 }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string", "maxLength": 50 }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string", "maxLength": 5 }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string", "maxLength": 10 }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string", "maxLength": 255 } } } } } } } }, "responses": { "201": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "New supplier has been created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "A unique identifier for the Supplier." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/suppliers/{organizationId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationId", "description": "A guid uniquely identifying a supplier organization.\n", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-supplier", "summary": "Supplier", "description": "Returns a single supplier for a given organizationId", "tags": [ "Supplier" ], "security": [ { "client_auth": [ "read:supplier" ] } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "A supplier organization.", "required": [ "organizationId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "System-generated ID that uniquely identifies the supplier." }, "name": { "type": "string", "description": "The name of the supplier.", "example": "SupplierName" }, "organizationCode": { "type": "string", "description": "Client-defined code that uniquely identifies the supplier.", "example": "SupplierCode" }, "description": { "type": "string", "description": "A description of the supplier.", "example": "Description of the supplier" }, "billingName": { "type": "string", "description": "The billing name of the supplier.", "example": "Billing Name" }, "externalCode": { "type": "string", "description": "The external code of the supplier.", "example": "External Code" }, "active": { "type": "boolean", "description": "Indicator of the supplier's active status. True if the supplier is active. Otherwise, false.", "example": true }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.", "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.", "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.", "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.", "example": "123-456-7890" }, "mailingAddress": { "type": "object", "description": "The mailing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "billingAddress": { "type": "object", "description": "The billing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "legal": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true }, "taxMarginPercent": { "description": "The tax margin percent of the legal entity of the supplier.", "type": "number", "format": "double", "example": 0.1 } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-update-supplier", "summary": "Update Supplier", "description": "Update an existing supplier in Beeline Enterprise.\n", "tags": [ "Supplier" ], "security": [ { "client_auth": [ "write:supplier" ] } ], "requestBody": { "description": "The supplier details to be updated.", "content": { "application/json": { "schema": { "type": "object", "description": "A Supplier.", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the supplier.", "maxLength": 255, "example": "SupplierName" }, "externalCode": { "type": "string", "description": "The external code of the supplier.", "maxLength": 255, "example": "External Code" }, "description": { "type": "string", "description": "A description of the supplier.", "maxLength": 255, "example": "Description of the supplier" }, "billingName": { "type": "string", "description": "The billing name of the supplier.", "maxLength": 100, "example": "Billing Name" }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "maxLength": 510, "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "mailingAddress": { "type": "object", "description": "The mailing address information of the supplier.", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string", "description": "The first line of the address, typically containing the street number and street name.", "maxLength": 150, "example": "123 Technological Pkwy." }, "line2": { "type": "string", "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "maxLength": 150, "example": "Suite 1000" }, "city": { "type": "string", "description": "The city or locality of the address.", "maxLength": 50, "example": "Des Moines" }, "stateCode": { "type": "string", "description": "The code or abbreviation for the state or region of the address.", "maxLength": 5, "example": "IA" }, "postalCode": { "type": "string", "description": "The postal or zip code of the address.", "maxLength": 10, "example": "50320" }, "countryCode": { "type": "string", "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "maxLength": 255, "example": "US" } } }, "billingAddress": { "type": "object", "description": "The billing address information of the supplier.", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string", "description": "The first line of the address, typically containing the street number and street name.", "maxLength": 150, "example": "123 Technological Pkwy." }, "line2": { "type": "string", "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "maxLength": 150, "example": "Suite 1000" }, "city": { "type": "string", "description": "The city or locality of the address.", "maxLength": 50, "example": "Des Moines" }, "stateCode": { "type": "string", "description": "The code or abbreviation for the state or region of the address.", "maxLength": 5, "example": "IA" }, "postalCode": { "type": "string", "description": "The postal or zip code of the address.", "maxLength": 10, "example": "50320" }, "countryCode": { "type": "string", "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "maxLength": 255, "example": "US" } } } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Supplier was successfully updated.", "content": { "application/json": { "schema": { "type": "object", "description": "A supplier organization.", "required": [ "organizationId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "System-generated ID that uniquely identifies the supplier." }, "name": { "type": "string", "description": "The name of the supplier.", "example": "SupplierName" }, "organizationCode": { "type": "string", "description": "Client-defined code that uniquely identifies the supplier.", "example": "SupplierCode" }, "description": { "type": "string", "description": "A description of the supplier.", "example": "Description of the supplier" }, "billingName": { "type": "string", "description": "The billing name of the supplier.", "example": "Billing Name" }, "externalCode": { "type": "string", "description": "The external code of the supplier.", "example": "External Code" }, "active": { "type": "boolean", "description": "Indicator of the supplier's active status. True if the supplier is active. Otherwise, false.", "example": true }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.", "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.", "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.", "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.", "example": "123-456-7890" }, "mailingAddress": { "type": "object", "description": "The mailing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "billingAddress": { "type": "object", "description": "The billing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "legal": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true }, "taxMarginPercent": { "description": "The tax margin percent of the legal entity of the supplier.", "type": "number", "format": "double", "example": 0.1 } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/suppliers/{organizationId}/legal-entities": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationId", "description": "A guid uniquely identifying a supplier organization.\n", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-create-supplier-legal-entity", "summary": "Create Supplier Legal Entity", "description": "Adds a new legal entity for a supplier.\n", "tags": [ "Supplier Legal Entity" ], "security": [ { "client_auth": [ "write:supplier" ] } ], "requestBody": { "description": "The supplier legal entity details.\n", "content": { "application/json": { "schema": { "type": "object", "description": "A Supplier Legal Entity.", "required": [ "name", "countryCode" ], "properties": { "name": { "type": "string", "description": "Name of the supplier legal entity.\n", "maxLength": 255, "example": "Legal entity name" }, "countryCode": { "type": "string", "description": "The supplier legal entity country code.\n", "maxLength": 255, "example": "US" }, "apCode": { "type": "string", "description": "The legal entity AP code.\n", "maxLength": 20, "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number for the supplier.\n", "maxLength": 25, "example": "1234" }, "taxExempt": { "type": "boolean", "description": "A boolean value identifying if the supplier is tax exempt or not.\n", "example": true } } } } } }, "responses": { "201": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "New supplier legal entity has been created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "legalEntityId": { "type": "string", "format": "uuid", "description": "A unique identifier for a Supplier legal entity." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/suppliers/{organizationId}/legal-entities/{legalEntityId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationId", "description": "A guid uniquely identifying a supplier organization.\n", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "legalEntityId", "description": "Uniquely identifies a supplier legal entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "put": { "operationId": "put-update-supplier-legal-entity", "summary": "Update Supplier Legal Entity", "description": "Update an existing supplier legal entity in Beeline Enterprise.\n", "tags": [ "Supplier Legal Entity" ], "security": [ { "client_auth": [ "write:supplier" ] } ], "requestBody": { "description": "The supplier legal entity details to be updated.", "content": { "application/json": { "schema": { "type": "object", "description": "Legal Entity", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "maxLength": 255, "example": "Legal Entity Name" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "maxLength": 20, "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "maxLength": 25, "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Supplier legal entity was successfully updated.", "content": { "application/json": { "schema": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/suppliers/{organizationId}/legal-entity-tax-definitions": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationId", "description": "A guid uniquely identifying a supplier organization.\n", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-supplier-legal-entity-tax-definition-list", "summary": "Supplier Legal Entity Tax Definition List", "description": "Retrieves the tax definitions associated with a specific legal entity.\n", "tags": [ "Supplier Legal Entity" ], "security": [ { "client_auth": [ "read:supplier" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of supplier legal entity tax definitions", "content": { "application/json": { "schema": { "type": "object", "description": "The list of supplier legal entity tax definitions.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of supplier legal entity tax definitions." }, "value": { "type": "array", "description": "A list of supplier legal entity tax definitions.", "items": { "type": "object", "description": "A supplier legal entity tax definition.", "required": [ "legalEntityTaxDefinitionId", "taxDefinitionCode", "registrationNumber" ], "properties": { "legalEntityTaxDefinitionId": { "type": "string", "format": "uuid", "description": "A unique identifier of the supplier legal entity tax definition." }, "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition.", "example": 12.34 } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "post": { "operationId": "post-create-supplier-legal-entity-tax-definition", "summary": "Create Supplier Legal Entity Tax Definition", "description": "Creates a tax definition for the specified legal entity.\n", "tags": [ "Supplier Legal Entity" ], "security": [ { "client_auth": [ "write:supplier" ] } ], "requestBody": { "description": "The supplier legal entity tax definition details.\n", "content": { "application/json": { "schema": { "type": "object", "description": "A Supplier Legal Entity Tax Definition.", "required": [ "taxDefinitionCode", "registrationNumber" ], "properties": { "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "maxLength": 255, "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "maxLength": 50, "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition. This is optional by default but required if tax definition has a tax calculation type of Margin.", "example": 12.34 } } } } } }, "responses": { "201": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "New supplier legal entity tax definition has been created", "content": { "application/json": { "schema": { "type": "object", "properties": { "legalEntityTaxDefinitionId": { "type": "string", "format": "uuid", "description": "A unique identifier of the supplier legal entity tax definition." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/suppliers/{organizationId}/legal-entity-tax-definitions/{legalEntityTaxDefinitionId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationId", "description": "A guid uniquely identifying a supplier organization.\n", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "legalEntityTaxDefinitionId", "description": "Uniquely identifies a supplier legal entity tax definition.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-supplier-legal-entity-tax-definition", "summary": "Supplier Legal Entity Tax Definition", "description": "Returns a single tax definition for a given legal entity.\n", "tags": [ "Supplier Legal Entity" ], "security": [ { "client_auth": [ "read:supplier" ] } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Supplier legal entity tax definition", "content": { "application/json": { "schema": { "type": "object", "description": "A supplier legal entity tax definition.", "required": [ "legalEntityTaxDefinitionId", "taxDefinitionCode", "registrationNumber" ], "properties": { "legalEntityTaxDefinitionId": { "type": "string", "format": "uuid", "description": "A unique identifier of the supplier legal entity tax definition." }, "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition.", "example": 12.34 } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-update-supplier-legal-entity-tax-definition", "summary": "Update Supplier Legal Entity Tax Definition", "description": "Updates an existing tax definition for the specified legal entity.\n", "tags": [ "Supplier Legal Entity" ], "security": [ { "client_auth": [ "write:supplier" ] } ], "requestBody": { "description": "The updated supplier legal entity tax definition details.\n", "content": { "application/json": { "schema": { "type": "object", "description": "A Supplier Legal Entity Tax Definition.", "required": [ "taxDefinitionCode", "registrationNumber" ], "properties": { "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "maxLength": 255, "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "maxLength": 50, "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition. This is optional by default but required if tax definition has a tax calculation type of Margin.", "example": 12.34 } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Supplier legal entity tax definition has been updated", "content": { "application/json": { "schema": { "type": "object", "description": "A supplier legal entity tax definition.", "required": [ "legalEntityTaxDefinitionId", "taxDefinitionCode", "registrationNumber" ], "properties": { "legalEntityTaxDefinitionId": { "type": "string", "format": "uuid", "description": "A unique identifier of the supplier legal entity tax definition." }, "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition.", "example": 12.34 } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-supplier-legal-entity-tax-definition", "summary": "Delete Supplier Legal Entity Tax Definition", "description": "Deletes a specific tax definition for the specified legal entity.\n", "tags": [ "Supplier Legal Entity" ], "security": [ { "client_auth": [ "write:supplier" ] } ], "responses": { "200": { "description": "Supplier legal entity tax definition has been deleted successfully", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } } }, "components": { "parameters": { "client-site-id": { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, "api-version": { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } }, "skip": { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, "top": { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, "supplier-active-only": { "in": "query", "name": "activeOnly", "description": "A boolean value representing whether to query for only active suppliers.", "required": false, "schema": { "type": "boolean", "default": false } }, "supplier-organization-id": { "in": "path", "name": "organizationId", "description": "A guid uniquely identifying a supplier organization.\n", "required": true, "schema": { "type": "string", "format": "uuid" } }, "legal-entity-id": { "in": "path", "name": "legalEntityId", "description": "Uniquely identifies a supplier legal entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "legal-entity-tax-definition-id": { "in": "path", "name": "legalEntityTaxDefinitionId", "description": "Uniquely identifies a supplier legal entity tax definition.", "required": true, "schema": { "type": "string", "format": "uuid" } } }, "headers": { "rate-limit-limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "rate-limit-remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "rate-limit-reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } }, "retry-after": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "responses": { "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } }, "schemas": { "supplier-organization-list": { "type": "array", "description": "A list of suppliers and their organization details.", "items": { "type": "object", "description": "A supplier organization.", "required": [ "organizationId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "System-generated ID that uniquely identifies the supplier." }, "name": { "type": "string", "description": "The name of the supplier.", "example": "SupplierName" }, "organizationCode": { "type": "string", "description": "Client-defined code that uniquely identifies the supplier.", "example": "SupplierCode" }, "description": { "type": "string", "description": "A description of the supplier.", "example": "Description of the supplier" }, "billingName": { "type": "string", "description": "The billing name of the supplier.", "example": "Billing Name" }, "externalCode": { "type": "string", "description": "The external code of the supplier.", "example": "External Code" }, "active": { "type": "boolean", "description": "Indicator of the supplier's active status. True if the supplier is active. Otherwise, false.", "example": true }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.", "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.", "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.", "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.", "example": "123-456-7890" }, "mailingAddress": { "type": "object", "description": "The mailing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "billingAddress": { "type": "object", "description": "The billing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "legal": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true }, "taxMarginPercent": { "description": "The tax margin percent of the legal entity of the supplier.", "type": "number", "format": "double", "example": 0.1 } } } } } }, "supplier-organization-model": { "type": "object", "description": "A supplier organization.", "required": [ "organizationId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "System-generated ID that uniquely identifies the supplier." }, "name": { "type": "string", "description": "The name of the supplier.", "example": "SupplierName" }, "organizationCode": { "type": "string", "description": "Client-defined code that uniquely identifies the supplier.", "example": "SupplierCode" }, "description": { "type": "string", "description": "A description of the supplier.", "example": "Description of the supplier" }, "billingName": { "type": "string", "description": "The billing name of the supplier.", "example": "Billing Name" }, "externalCode": { "type": "string", "description": "The external code of the supplier.", "example": "External Code" }, "active": { "type": "boolean", "description": "Indicator of the supplier's active status. True if the supplier is active. Otherwise, false.", "example": true }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.", "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.", "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.", "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.", "example": "123-456-7890" }, "mailingAddress": { "type": "object", "description": "The mailing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "billingAddress": { "type": "object", "description": "The billing address information of the supplier.", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "legal": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true }, "taxMarginPercent": { "description": "The tax margin percent of the legal entity of the supplier.", "type": "number", "format": "double", "example": 0.1 } } } } }, "supplier-organization-create-model": { "type": "object", "description": "A Supplier.", "required": [ "name", "code" ], "properties": { "name": { "type": "string", "description": "The name of the supplier.\n", "maxLength": 255, "example": "SupplierName" }, "code": { "type": "string", "description": "The organization code of the supplier.\n", "maxLength": 50, "example": "SupplierCode" }, "description": { "type": "string", "description": "The description of the supplier.\n", "maxLength": 255, "example": "Description of the supplier." }, "billingName": { "type": "string", "description": "The billing name of the supplier.\n", "maxLength": 100, "example": "Billing Name." }, "externalCode": { "type": "string", "description": "The external code of the supplier.\n", "example": "External Code" }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "maxLength": 510, "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "active": { "type": "boolean", "description": "A boolean value representing the status of the supplier.\n", "example": true }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.\n", "maxLength": 30, "example": "123-456-7890" }, "mailingAddress": { "description": "The mailing address of the supplier.", "type": "object", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "description": "The first line of the adress, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string", "maxLength": 150 }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string", "maxLength": 150 }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string", "maxLength": 50 }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string", "maxLength": 5 }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string", "maxLength": 10 }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string", "maxLength": 255 } } }, "billingAddress": { "description": "The billing address of the supplier.", "type": "object", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "description": "The first line of the adress, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string", "maxLength": 150 }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string", "maxLength": 150 }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string", "maxLength": 50 }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string", "maxLength": 5 }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string", "maxLength": 10 }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string", "maxLength": 255 } } } } }, "supplier-organization-update-model": { "type": "object", "description": "A Supplier.", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the supplier.", "maxLength": 255, "example": "SupplierName" }, "externalCode": { "type": "string", "description": "The external code of the supplier.", "maxLength": 255, "example": "External Code" }, "description": { "type": "string", "description": "A description of the supplier.", "maxLength": 255, "example": "Description of the supplier" }, "billingName": { "type": "string", "description": "The billing name of the supplier.", "maxLength": 100, "example": "Billing Name" }, "emailAddress": { "type": "string", "description": "The e-mail address of the supplier.\n", "maxLength": 510, "example": "email@address.com" }, "vettingStatus": { "type": "string", "description": "The vetting status of the supplier.\n", "enum": [ "unknown", "vetted", "notVetted" ], "example": "unknown" }, "businessPhone": { "type": "string", "description": "The business phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "mobilePhone": { "type": "string", "description": "The mobile phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "faxPhone": { "type": "string", "description": "The fax phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "homePhone": { "type": "string", "description": "The home phone number of the supplier.", "maxLength": 30, "example": "123-456-7890" }, "mailingAddress": { "type": "object", "description": "The mailing address information of the supplier.", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string", "description": "The first line of the address, typically containing the street number and street name.", "maxLength": 150, "example": "123 Technological Pkwy." }, "line2": { "type": "string", "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "maxLength": 150, "example": "Suite 1000" }, "city": { "type": "string", "description": "The city or locality of the address.", "maxLength": 50, "example": "Des Moines" }, "stateCode": { "type": "string", "description": "The code or abbreviation for the state or region of the address.", "maxLength": 5, "example": "IA" }, "postalCode": { "type": "string", "description": "The postal or zip code of the address.", "maxLength": 10, "example": "50320" }, "countryCode": { "type": "string", "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "maxLength": 255, "example": "US" } } }, "billingAddress": { "type": "object", "description": "The billing address information of the supplier.", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string", "description": "The first line of the address, typically containing the street number and street name.", "maxLength": 150, "example": "123 Technological Pkwy." }, "line2": { "type": "string", "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "maxLength": 150, "example": "Suite 1000" }, "city": { "type": "string", "description": "The city or locality of the address.", "maxLength": 50, "example": "Des Moines" }, "stateCode": { "type": "string", "description": "The code or abbreviation for the state or region of the address.", "maxLength": 5, "example": "IA" }, "postalCode": { "type": "string", "description": "The postal or zip code of the address.", "maxLength": 10, "example": "50320" }, "countryCode": { "type": "string", "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "maxLength": 255, "example": "US" } } } } }, "supplier-legal-entity-create-model": { "type": "object", "description": "A Supplier Legal Entity.", "required": [ "name", "countryCode" ], "properties": { "name": { "type": "string", "description": "Name of the supplier legal entity.\n", "maxLength": 255, "example": "Legal entity name" }, "countryCode": { "type": "string", "description": "The supplier legal entity country code.\n", "maxLength": 255, "example": "US" }, "apCode": { "type": "string", "description": "The legal entity AP code.\n", "maxLength": 20, "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number for the supplier.\n", "maxLength": 25, "example": "1234" }, "taxExempt": { "type": "boolean", "description": "A boolean value identifying if the supplier is tax exempt or not.\n", "example": true } } }, "supplier-legal-entity-update-model": { "type": "object", "description": "Legal Entity", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "maxLength": 255, "example": "Legal Entity Name" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "maxLength": 20, "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "maxLength": 25, "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true } } }, "supplier-legal-entity-model": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true } } }, "supplier-legal-entity-tax-definition-list": { "type": "array", "description": "A list of supplier legal entity tax definitions.", "items": { "type": "object", "description": "A supplier legal entity tax definition.", "required": [ "legalEntityTaxDefinitionId", "taxDefinitionCode", "registrationNumber" ], "properties": { "legalEntityTaxDefinitionId": { "type": "string", "format": "uuid", "description": "A unique identifier of the supplier legal entity tax definition." }, "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition.", "example": 12.34 } } } }, "supplier-legal-entity-tax-definition-request-model": { "type": "object", "description": "A Supplier Legal Entity Tax Definition.", "required": [ "taxDefinitionCode", "registrationNumber" ], "properties": { "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "maxLength": 255, "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "maxLength": 50, "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition. This is optional by default but required if tax definition has a tax calculation type of Margin.", "example": 12.34 } } }, "supplier-legal-entity-tax-definition-model": { "type": "object", "description": "A supplier legal entity tax definition.", "required": [ "legalEntityTaxDefinitionId", "taxDefinitionCode", "registrationNumber" ], "properties": { "legalEntityTaxDefinitionId": { "type": "string", "format": "uuid", "description": "A unique identifier of the supplier legal entity tax definition." }, "taxDefinitionCode": { "type": "string", "description": "The tax definition code.", "example": "TaxCode" }, "registrationNumber": { "type": "string", "description": "The registration number.", "example": "801025" }, "taxMarginPercent": { "type": "number", "format": "double", "description": "The tax margin percent of the supplier legal entity tax definition.", "example": 12.34 } } }, "supplier-organization-address": { "type": "object", "description": "Base Address Information", "required": [ "addressId" ], "properties": { "addressId": { "description": "System-generated ID that uniquely identifies the address.", "format": "uuid", "type": "string" }, "line1": { "description": "The first line of the address, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string" }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string" }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string" }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string" }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string" }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string" } } }, "supplier-organization-legal": { "type": "object", "description": "Legal Entity", "required": [ "legalEntityId" ], "properties": { "legalEntityId": { "description": "System-generated ID that uniquely identifies the legal entity of the supplier.", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the legal entity of the supplier.", "example": "Legal Entity Name" }, "countryCode": { "type": "string", "description": "The unique code for the country of the supplier.", "example": "US" }, "apCode": { "type": "string", "description": "The accounts payable code of the supplier.", "example": "ICT10101" }, "blanketPONumber": { "type": "string", "description": "The blanket purchase order number of the supplier.", "example": "1234" }, "taxExempt": { "type": "boolean", "description": "Indicator of supplier's tax exempt status. True if the supplier is tax exempt. Otherwise, false.", "example": true }, "taxMarginPercent": { "description": "The tax margin percent of the legal entity of the supplier.", "type": "number", "format": "double", "example": 0.1 } } }, "error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } }, "error-response": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "empty-response": { "type": "null" }, "supplier-organization-address-request": { "type": "object", "description": "Base Address Information", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "description": "The first line of the adress, typically containing the street number and street name.", "example": "123 Technological Pkwy.", "type": "string", "maxLength": 150 }, "line2": { "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "example": "Suite 1000", "type": "string", "maxLength": 150 }, "city": { "description": "The city or locality of the address.", "example": "Des Moines", "type": "string", "maxLength": 50 }, "stateCode": { "description": "The code or abbreviation for the state or region of the address.", "example": "IA", "type": "string", "maxLength": 5 }, "postalCode": { "description": "The postal or zip code of the address.", "example": "50320", "type": "string", "maxLength": 10 }, "countryCode": { "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "example": "US", "type": "string", "maxLength": 255 } } }, "supplier-organization-address-update-model": { "type": "object", "description": "Base Address Information", "required": [ "line1", "city", "stateCode", "postalCode", "countryCode" ], "properties": { "line1": { "type": "string", "description": "The first line of the address, typically containing the street number and street name.", "maxLength": 150, "example": "123 Technological Pkwy." }, "line2": { "type": "string", "description": "The second line of the address, typically containing additional information such as apartment or suite number, building name, or floor number.", "maxLength": 150, "example": "Suite 1000" }, "city": { "type": "string", "description": "The city or locality of the address.", "maxLength": 50, "example": "Des Moines" }, "stateCode": { "type": "string", "description": "The code or abbreviation for the state or region of the address.", "maxLength": 5, "example": "IA" }, "postalCode": { "type": "string", "description": "The postal or zip code of the address.", "maxLength": 10, "example": "50320" }, "countryCode": { "type": "string", "description": "The alpha-2 code for the country of the address, typically a two-letter code such as \"US\" for the United States or \"CA\" for Canada.", "maxLength": 255, "example": "US" } } } }, "securitySchemes": { "client_auth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://integrations.auth.beeline.com/oauth/token", "scopes": { "read:supplier": "Read Supplier data", "write:supplier": "Write Supplier data" } } } } }, "examples": { "rate-limit-error-response": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } }