API explorerChangelog
API explorer
Changelog

Theme switcher

API Reference

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

http://sdp.tealbook.com/graphql

Language Box

Was this section helpful?

What made this section unhelpful for you?

Introduction to SDP

The TealBook Supplier Data Platform (SDP) delivers trusted supplier data to targeted enterprise systems via API integration. SDP continuously enriches and autonomously refreshes supplier data.

TealBook provides attribute-level trust scores that can be used in conjunction with our Business Rules Engine to give you control and flexibility over which data attributes are accepted and provided.

If you have any Support inquiries, please reach out to support@tealbook.com or submit a ticket here.

Query

The Query type in GraphQL represents the entry point for retrieving data from the API. It defines the available read-only operations (queries) that clients can execute to fetch data.

Mutation

The Mutation type in GraphQL is used for modifying or creating data. It defines the operations (mutations) that allow clients to make changes to the data stored on the server, such as creating, updating, or deleting resources

Objects

Objects in GraphQL represent complex data structures. They define the fields and their types that can be queried in a GraphQL API. Objects can have nested fields and relationships with other objects.

Was this section helpful?

What made this section unhelpful for you?

Address_Parsed

The address_parsed object enables users to query for a supplier address as parsed components rather than just a complete_address string.

Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 { address_parsed { tealBook_trust_score street_address { client_value tealbook_value merged_value merged_source } city { client_value tealbook_value merged_value merged_source } state { client_value tealbook_value merged_value merged_source } country { client_value tealbook_value merged_value merged_source } zip_postal_code { client_value tealbook_value merged_value merged_source } } }
Was this section helpful?

What made this section unhelpful for you?

FetchCumulativePipelineStats

The FetchCumulativePipelineStats section in the Tealbook SDP API allows users to retrieve cumulative pipeline statistics. By accessing this section, users can obtain information on the overall progress and metrics of their pipeline, aiding in the analysis and optimization of their business processes.

FetchCumulativePipelineStats

number_of_completed_pipelinesfloat Required
number_of_failed_pipelinesfloat Required
number_of_pending_pipelinesfloat Required
number_of_pipelinesfloat Required
number_of_processing_pipelinesfloat Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 { "number_of_completed_pipelines": null, "number_of_failed_pipelines": null, "number_of_pending_pipelines": null, "number_of_pipelines": null, "number_of_processing_pipelines": null }
Was this section helpful?

What made this section unhelpful for you?

FetchCumulativeRecordsStats

The FetchCumulativeRecordsStats section in the Tealbook SDP API allows users to retrieve cumulative record-level statistics. With this functionality, users can gain insights into their data, track progress over time, and make informed decisions based on the provided metrics.

FetchCumulativeRecordsStats

cumulative_number_of_records_matchedfloat Required
cumulative_records_matched_percentagefloat Required
duplicates_records_percentagefloat Required
number_of_duplicates_recordsfloat Required
number_of_recordsfloat Required
number_of_records_droppedfloat Required
number_of_records_eligible_for_matchingfloat Required
number_of_records_failedfloat Required
number_of_records_hil_matchedfloat Required
number_of_records_matchedfloat Required
number_of_records_need_ambiguous_matchingfloat Required
number_of_records_not_matchedfloat Required
number_of_records_pendingfloat Required
number_of_records_processingfloat Required
records_dropped_percentagefloat Required
records_eligible_for_matching_percentagefloat Required
records_failed_percentagefloat Required
records_hil_matched_percentagefloat Required
records_matched_percentagefloat Required
records_need_ambiguous_matching_percentagefloat Required
records_not_matched_percentagefloat Required
records_pending_percentagefloat Required
records_processing_percentagefloat Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "cumulative_number_of_records_matched": null, "cumulative_records_matched_percentage": null, "duplicates_records_percentage": null, "number_of_duplicates_records": null, "number_of_records": null, "number_of_records_dropped": null, "number_of_records_eligible_for_matching": null, "number_of_records_failed": null, "number_of_records_hil_matched": null, "number_of_records_matched": null, "number_of_records_need_ambiguous_matching": null, "number_of_records_not_matched": null, "number_of_records_pending": null, "number_of_records_processing": null, "records_dropped_percentage": null, "records_eligible_for_matching_percentage": null, "records_failed_percentage": null, "records_hil_matched_percentage": null, "records_matched_percentage": null, "records_need_ambiguous_matching_percentage": null, "records_not_matched_percentage": null, "records_pending_percentage": null, "records_processing_percentage": null }
Was this section helpful?

What made this section unhelpful for you?

FetchPipelineStats

The FetchPipelineStats section in the Tealbook SDP API allows users to retrieve statistical information related to pipeline data. Users can access various metrics and performance indicators, enabling them to monitor and analyze the efficiency of their pipelines.

FetchPipelineStats

created_atdatetime Required
created_bystring Required
cumulative_match_ratefloat Required
data_typestring
idstring Required
organization_idstring
original_filenamestring
pipeline_namestring
randomized_filenamestring
source_namestring Required
statusstring Required
total_recordsfloat Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "created_at": null, "created_by": null, "cumulative_match_rate": null, "data_type": null, "id": null, "organization_id": null, "original_filename": null, "pipeline_name": null, "randomized_filename": null, "source_name": null, "status": null, "total_records": null }
Was this section helpful?

What made this section unhelpful for you?

Naics

The Naics section in the Tealbook SDP API provides access to the North American Industry Classification System (NAICS) codes and related information. Users can retrieve and manage NAICS codes to classify and categorize businesses accurately.

Naics

naicsstring Required
naics_idstring Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "naics": null, "naics_id": null }
Was this section helpful?

What made this section unhelpful for you?

PageMetaDto

The PageMetaDto section provides users with access to metadata for pages within the Tealbook SDP project. By utilizing this section, users can retrieve key information about pages, such as their title, URL, and creation date. This allows for efficient management and analysis of page data within the Tealbook SDP ecosystem.

PageMetaDto

hasNextPageboolean Required
hasPreviousPageboolean Required
itemCountfloat Required

Number of items of the respective entity type present in the database

limitfloat Required
offsetfloat Required
pagefloat Required
pageCountfloat Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 { "hasNextPage": false, "hasPreviousPage": false, "itemCount": null, "limit": null, "offset": null, "page": null, "pageCount": null }
Was this section helpful?

What made this section unhelpful for you?

PageOptionsDto

The PageOptionsDto section of the Tealbook SDP API allows users to customize the pagination settings for retrieving lists of resources. With this section, users can control the number of items per page, specify the desired page number, and sort the results based on certain criteria.

PageOptionsDto

limitfloat
offsetfloat
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "limit": 10, "offset": 0 }
Was this section helpful?

What made this section unhelpful for you?

PipelineOrderBy

The PipelineOrderBy section in the Tealbook SDP API allows users to specify the order in which pipelines should be sorted. By utilizing this section, users can customize the sorting of pipelines based on their specific requirements, enhancing the efficiency and organization of their workflows.

PipelineOrderBy

created_atstring
Enum values:
ascdesc
created_bystring
Enum values:
ascdesc
deleted_atstring
Enum values:
ascdesc
idstring
Enum values:
ascdesc
pipeline_namestring
Enum values:
ascdesc
source_typestring
Enum values:
ascdesc
statusstring
Enum values:
ascdesc
total_recordsstring
Enum values:
ascdesc
updated_atstring
Enum values:
ascdesc
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 { "created_at": "asc", "created_by": "asc", "deleted_at": "asc", "id": "asc", "pipeline_name": "asc", "source_type": "asc", "status": "asc", "total_records": "asc", "updated_at": "asc" }
Was this section helpful?

What made this section unhelpful for you?

PipelinesFilterBy

The PipelinesFilterBy section in the Tealbook SDP API allows users to filter pipelines based on specific criteria. By utilizing this section, users can easily narrow down their search results and retrieve pipelines that meet their specific requirements.

PipelinesFilterBy

created_atdatetime
created_bystring
organization_idstring
organization_namestring
pipeline_idstring
pipeline_namestring
source_typestring
statusstring
total_recordsfloat
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 { "created_at": null, "created_by": null, "organization_id": null, "organization_name": null, "pipeline_id": null, "pipeline_name": null, "source_type": null, "status": null, "total_records": null }
Was this section helpful?

What made this section unhelpful for you?

UnmatchedRecords

The UnmatchedRecords section of the Tealbook SDP API allows users to retrieve a list of unmatched records. By accessing this section, users can identify records that have not been successfully matched with the existing data in the Tealbook SDP system, enabling them to take appropriate actions to resolve any discrepancies or update the data accordingly.

UnmatchedRecords

address_gap_detailsstring
address_statusstring
annual_revenue_bucketstring
annual_revenue_currencystring
annual_revenue_numberstring
cage_codestring
citystring
company_namestring Required
complete_addressstring
contact_emailstring
countrystring
descriptionstring
duns_numberstring
employee_countstring
errorsarray

Show child attributes

internal_source_namestring
internal_supplier_idstring Required
last_payment_datestring
leistring
naicsstring
sam_ueistring
statestring
street_addressstring
tax_idstring
tax_id_localitystring
unmatched_reasonstring Required
web_domainstring
year_foundedstring
zip_postal_codestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 { "address_gap_details": null, "address_status": null, "annual_revenue_bucket": null, "annual_revenue_currency": null, "annual_revenue_number": null, "cage_code": null, "city": null, "company_name": null, "complete_address": null, "contact_email": null, "country": null, "description": null, "duns_number": null, "employee_count": null, "errors": [ { "msg": null } ], "internal_source_name": null, "internal_supplier_id": null, "last_payment_date": null, "lei": null, "naics": null, "sam_uei": null, "state": null, "street_address": null, "tax_id": null, "tax_id_locality": null, "unmatched_reason": null, "web_domain": "", "year_founded": null, "zip_postal_code": null }
Was this section helpful?

What made this section unhelpful for you?

UploadResultErrors

The UploadResultErrors section in the Tealbook SDP project allows users to review and manage any errors that occur during the upload of result data. Users can gain insights into the specific errors encountered, helping them troubleshoot and ensure accurate data integration with the Tealbook SDP system.

UploadResultErrors

error_typestring Required
Enum values:
INVALID_DATAINVALID_FILEINVALID_FILE_TYPEINVALID_HEADERSUPLOAD_ERROR
errorsstring Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "error_type": "INVALID_DATA", "errors": null }
Was this section helpful?

What made this section unhelpful for you?

UploadResultSuccess

The UploadResultSuccess section of the Tealbook SDP API enables users to retrieve and manage successful results from uploaded data. Users can access detailed information about successful uploads, such as status and statistics, and perform actions like downloading or deleting the uploaded data.

UploadResultSuccess

pipeline_idstring Required
resultstring Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "pipeline_id": null, "result": null }
Was this section helpful?

What made this section unhelpful for you?

VendorMasterInput

The VendorMasterInput section of the Tealbook SDP API allows users to manage and update vendor information within their system. Users can add and modify vendor details, such as contact information and payment terms, to ensure accurate and up-to-date records.

VendorMasterInput

annual_revenue_bucketstring
annual_revenue_currencystring
annual_revenue_numberfloat
cage_codestring
citystring
company_namestring
complete_addressstring
contact_emailstring
countrystring
descriptionstring
duns_numberstring
employee_countfloat
internal_source_namestring
internal_supplier_idstring
last_payment_datestring
leistring
naicsstring
sam_ueistring
statestring
street_addressstring
tax_idstring
tax_id_localitystring
web_domainarray
year_foundedfloat
zip_postal_codestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "annual_revenue_bucket": null, "annual_revenue_currency": null, "annual_revenue_number": null, "cage_code": null, "city": null, "company_name": null, "complete_address": null, "contact_email": null, "country": null, "description": null, "duns_number": null, "employee_count": null, "internal_source_name": null, "internal_supplier_id": null, "last_payment_date": null, "lei": null, "naics": null, "sam_uei": null, "state": null, "street_address": null, "tax_id": null, "tax_id_locality": null, "web_domain": [], "year_founded": null, "zip_postal_code": null }
Was this section helpful?

What made this section unhelpful for you?

VendorMasterOutput

The VendorMasterOutput section in the Tealbook SDP API provides users with access to vendor master data. Through this section, users can retrieve detailed information about vendors, including their contact information, address, and other relevant details. This allows users to effectively manage and analyze their vendor relationships within the Tealbook SDP platform.

VendorMasterOutput

annual_revenue_bucketstring
annual_revenue_currencystring
annual_revenue_numberstring
cage_codestring
citystring
company_namestring Required
complete_addressstring
contact_emailstring
countrystring
descriptionstring
duns_numberstring
employee_countstring
internal_source_namestring
internal_supplier_idstring Required
last_payment_datestring
leistring
naicsstring
sam_ueistring
statestring
street_addressstring
tax_idstring
tax_id_localitystring
web_domainarray
year_foundedstring
zip_postal_codestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "annual_revenue_bucket": null, "annual_revenue_currency": null, "annual_revenue_number": null, "cage_code": null, "city": null, "company_name": null, "complete_address": null, "contact_email": null, "country": null, "description": null, "duns_number": null, "employee_count": null, "internal_source_name": null, "internal_supplier_id": null, "last_payment_date": null, "lei": null, "naics": null, "sam_uei": null, "state": null, "street_address": null, "tax_id": null, "tax_id_locality": null, "web_domain": [], "year_founded": null, "zip_postal_code": null }
Was this section helpful?

What made this section unhelpful for you?

VmSuccessResponse

The VmSuccessResponse section provides detailed information on the successful response returned by the Tealbook SDP API when inputting Vendor Master (VM) data. Users can leverage this section to understand the structure and properties of the successful response object, enabling them to extract relevant data and handle it programmatically.

VmSuccessResponse

pipeline_idstring Required
resultstring Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "pipeline_id": null, "result": null }
Was this section helpful?

What made this section unhelpful for you?

Certifications

The Certifications section allows users to manage and retrieve information about supplier certifications within the system. Users can retrieve a list of all supplier certifications or details of a specific certification.

Certifications

cert_categorystring
cert_domainstring
cert_expiration_datestring
cert_idstring

TealBook's unique identifier for the certification.

cert_issue_datestring
cert_numberstring
cert_subcategorystring
cert_subtypestring
cert_typestring
certifying_bodystring
entity_typestring Required
supplier_match_confidencefloat
tealbook_idstring Required
tealbook_trust_scorestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "cert_category": null, "cert_domain": null, "cert_expiration_date": null, "cert_id": "", "cert_issue_date": null, "cert_number": null, "cert_subcategory": null, "cert_subtype": null, "cert_type": null, "certifying_body": null, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null }
Was this section helpful?

What made this section unhelpful for you?

EnrichedDetails

The EnrichedDetails section allows users to specify the information to be returned in response to the retrieveMatchedRecords query. Users may choose to retrieve the client_value (the original value submitted as part of the inputVmData mutation), tealbook_value (TealBook's USP value for the same attribute), the tealBook_trust_score (TealBook's trust score for the respective value), the merged_value and merged_source (the recommended value and source for a given supplier attribute, based the organization's Business Rules Engine configuration).

EnrichedDetails

client_valuestring
entity_typestring Required
merged_sourcestring
merged_valuestring
supplier_match_confidencefloat
tealbook_idstring Required
tealbook_trust_scorestring
tealbook_valuestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null }
Was this section helpful?

What made this section unhelpful for you?

Errors

The Errors section allows users to dive deeper into the Unmatched Reason provided for a given record as part of the retrieveUnmatchedRecords query. It provides a more detailed reason when records are dropped from processing.

Errors

msgstring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 { "msg": null }
Was this section helpful?

What made this section unhelpful for you?

Fields

The Fields section allows users to specify which fields they want to retrieve as part of the retrieveMatchedRecords query.

Fields

address_parsedarray

Show child attributes

annual_revenuearray

Show child attributes

cage_codearray

Show child attributes

certificationsarray

Show child attributes

company_namearray

Show child attributes

complete_addressarray

Show child attributes

contactsarray

Show child attributes

corporate_email_addressarray

Show child attributes

corporate_phone_numberarray

Show child attributes

duns_numberarray

Show child attributes

employee_countarray

Show child attributes

facebook_page_urlarray

Show child attributes

fax_numberarray

Show child attributes

goods_and_servicesarray

Show child attributes

gross_profitarray

Show child attributes

legal_structurearray

Show child attributes

leiarray

Show child attributes

linkedin_page_urlarray

Show child attributes

local_exchange_symbolarray

Show child attributes

location_typearray

Show child attributes

long_descriptionarray

Show child attributes

naicsarray

Show child attributes

net_incomearray

Show child attributes

operating_incomearray

Show child attributes

ownershiparray

Show child attributes

phone_numberarray

Show child attributes

public_company_flagarray

Show child attributes

sam_ueiarray

Show child attributes

short_descriptionarray

Show child attributes

sicarray

Show child attributes

tax_idarray

Show child attributes

total_assetsarray

Show child attributes

total_liabilitiesarray

Show child attributes

twitter_page_urlarray

Show child attributes

web_domainarray

Show child attributes

year_foundedarray

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 { "address_parsed": [ { "city": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "country": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "state": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "street_address": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "zip_postal_code": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null } } ], "annual_revenue": [ { "amount": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "currency": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "reliability_indicator": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "year": { "merged_source": null, "merged_value": null, "tealbook_value": null } } ], "cage_code": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "certifications": [ { "cert_category": null, "cert_domain": null, "cert_expiration_date": null, "cert_id": null, "cert_issue_date": null, "cert_number": null, "cert_subcategory": null, "cert_subtype": null, "cert_type": null, "certifying_body": null, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "company_name": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "complete_address": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "contacts": [ { "contact_email": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_name": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_phone_number": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_title": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "corporate_email_address": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "corporate_phone_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "duns_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "employee_count": [ { "count": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "reliability_indicator": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "facebook_page_url": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "fax_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "goods_and_services": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "gross_profit": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "legal_structure": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "lei": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "linkedin_page_url": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "local_exchange_symbol": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "location_type": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "long_description": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "naics": [ { "code": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "description": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "net_income": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "operating_income": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "ownership": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "phone_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "public_company_flag": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "sam_uei": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "short_description": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "sic": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "tax_id": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "total_assets": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "total_liabilities": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "twitter_page_url": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "web_domain": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "year_founded": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ] }
Was this section helpful?

What made this section unhelpful for you?

MatchedRecords

The MatchedRecords section allows users to retrieve all of the records associated with a given pipeline_id that were successfully matched to a TealBook USP.

MatchedRecords

fieldsobject

Show child attributes

internal_source_namestring
internal_supplier_id_or_vendor_numberstring Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 { "fields": { "address_parsed": [ { "city": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "country": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "state": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "street_address": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "zip_postal_code": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null } } ], "annual_revenue": [ { "amount": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "currency": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "reliability_indicator": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "year": { "merged_source": null, "merged_value": null, "tealbook_value": null } } ], "cage_code": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "certifications": [ { "cert_category": null, "cert_domain": null, "cert_expiration_date": null, "cert_id": null, "cert_issue_date": null, "cert_number": null, "cert_subcategory": null, "cert_subtype": null, "cert_type": null, "certifying_body": null, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "company_name": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "complete_address": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "contacts": [ { "contact_email": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_name": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_phone_number": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_title": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "corporate_email_address": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "corporate_phone_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "duns_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "employee_count": [ { "count": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "reliability_indicator": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "facebook_page_url": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "fax_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "goods_and_services": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "gross_profit": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "legal_structure": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "lei": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "linkedin_page_url": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "local_exchange_symbol": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "location_type": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "long_description": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "naics": [ { "code": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "description": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null } ], "net_income": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "operating_income": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "ownership": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "phone_number": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "public_company_flag": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "sam_uei": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "short_description": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "sic": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "tax_id": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "total_assets": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "total_liabilities": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "twitter_page_url": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "web_domain": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ], "year_founded": [ { "client_value": null, "entity_type": null, "merged_source": null, "merged_value": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "tealbook_value": null } ] }, "internal_source_name": null, "internal_supplier_id_or_vendor_number": null }
Was this section helpful?

What made this section unhelpful for you?

Contact

Contact

contact_emailobject

Show child attributes

contact_nameobject

Show child attributes

contact_phone_numberobject

Show child attributes

contact_titleobject

Show child attributes

entity_typestring Required
supplier_match_confidencefloat
tealbook_idstring Required
tealbook_trust_scorestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "contact_email": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_name": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_phone_number": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "contact_title": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null }
Was this section helpful?

What made this section unhelpful for you?

ContactEmailEnrichedDetails

ContactEmailEnrichedDetails

client_valuestring
merged_sourcestring
merged_valuestring
tealbook_valuestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }
Was this section helpful?

What made this section unhelpful for you?

ContactEnrichedDetails

ContactEnrichedDetails

merged_sourcestring
merged_valuestring
tealbook_valuestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 { "merged_source": null, "merged_value": null, "tealbook_value": null }
Was this section helpful?

What made this section unhelpful for you?

AnnualRevenue

AnnualRevenue

amountobject

Show child attributes

currencyobject

Show child attributes

entity_typestring Required
reliability_indicatorobject

Show child attributes

supplier_match_confidencefloat
tealbook_idstring Required
tealbook_trust_scorestring
yearobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 { "amount": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "currency": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "reliability_indicator": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null, "year": { "merged_source": null, "merged_value": null, "tealbook_value": null } }
Was this section helpful?

What made this section unhelpful for you?

EmployeeCount

EmployeeCount

countobject

Show child attributes

entity_typestring Required
reliability_indicatorobject

Show child attributes

supplier_match_confidencefloat
tealbook_idstring Required
tealbook_trust_scorestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "count": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "reliability_indicator": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null }
Was this section helpful?

What made this section unhelpful for you?

EnrichedNestedAttributeNoClient

EnrichedNestedAttributeNoClient

merged_sourcestring
merged_valuestring
tealbook_valuestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 { "merged_source": null, "merged_value": null, "tealbook_value": null }
Was this section helpful?

What made this section unhelpful for you?

SupplierNaics

SupplierNaics

codeobject

Show child attributes

descriptionobject

Show child attributes

entity_typestring Required
supplier_match_confidencefloat
tealbook_idstring Required
tealbook_trust_scorestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "code": { "client_value": null, "merged_source": null, "merged_value": null, "tealbook_value": null }, "description": { "merged_source": null, "merged_value": null, "tealbook_value": null }, "entity_type": null, "supplier_match_confidence": null, "tealbook_id": null, "tealbook_trust_score": null }
Was this section helpful?

What made this section unhelpful for you?

ApiCredential

ApiCredential

created_atdatetime
deleted_atdatetime
emailstring Required
enabledboolean Required
idid Required
organizationobject

Show child attributes

secretstring Required
supertokens_idstring Required
updated_atdatetime
userGroupobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 { "created_at": null, "deleted_at": null, "email": null, "enabled": false, "id": null, "organization": { "apiCredentials": [], "bre_rule_sets": [ { "bre_rule_data_attributes": [ { "created_at": null, "deleted_at": null, "id": null, "on_client_value": null, "on_empty_client_value": null, "organization_data_attribute": { "active": false, "certExpiryOption": "EXPIRED_GREATER_THAN_18_MONTHS", "created_at": null, "deleted_at": null, "id": null, "tb_data_attr": {}, "updated_at": null, "useCertsWithNoExpiry": false }, "ruleset": {}, "updated_at": null } ], "created_at": null, "deleted_at": null, "id": null, "name": null, "organization": {}, "updated_at": null, "updated_by_user": { "bre_rule_sets": [], "buyerOrgUnitId": null, "created_at": null, "deleted_at": null, "email": null, "enabled": false, "first_name": null, "id": null, "last_name": null, "organization": {}, "title": null, "tosAcceptedDate": null, "updated_at": null, "userGroups": [ { "apiCredentials": [], "created_at": null, "deleted_at": null, "id": null, "internal": false, "name": null, "permissions": [], "updated_at": null, "users": [] } ] } } ], "created_at": null, "deleted_at": null, "domains": [ { "created_at": null, "deleted_at": null, "id": null, "name": null, "organization": {}, "updated_at": null } ], "id": null, "name": null, "organization_product_features": [ { "created_at": null, "deleted_at": null, "id": null, "organization": {}, "organization_id": null, "product_feature": { "created_at": null, "deleted_at": null, "description": null, "id": null, "name": null, "organization_product_features": [], "updated_at": null }, "product_feature_id": null, "updated_at": null } ], "organization_saml_config": { "created_at": null, "deleted_at": null, "id": null, "organization": {}, "organization_id": null, "saml_client_id": null, "saml_enabled": false, "saml_third_party_id": null, "updated_at": null }, "organization_setting": { "created_at": null, "deleted_at": null, "hil_supplier_matching": "HIL", "id": null, "organization": {}, "updated_at": null }, "updated_at": null, "users": [ { "bre_rule_sets": [], "buyerOrgUnitId": null, "created_at": null, "deleted_at": null, "email": null, "enabled": false, "first_name": null, "id": null, "last_name": null, "organization": {}, "title": null, "tosAcceptedDate": null, "updated_at": null, "userGroups": [ { "apiCredentials": [], "created_at": null, "deleted_at": null, "id": null, "internal": false, "name": null, "permissions": [], "updated_at": null, "users": [] } ] } ] }, "secret": null, "supertokens_id": null, "updated_at": null, "userGroup": { "apiCredentials": [], "created_at": null, "deleted_at": null, "id": null, "internal": false, "name": null, "permissions": [], "updated_at": null, "users": [] } }
Was this section helpful?

What made this section unhelpful for you?

CreateNewSupplier

CreateNewSupplier

created_atdatetime Required
hil_match_response_idid Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "created_at": null, "hil_match_response_id": null }
Was this section helpful?

What made this section unhelpful for you?

FeatureFlagInput

FeatureFlagInput

keystring Required
valueboolean Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "key": null, "value": false }
Was this section helpful?

What made this section unhelpful for you?

RunTime

RunTime

finishdatetime
pipeline_run_numberfloat Required
pipeline_typestring
record_countfloat
run_typestring Required
startdatetime
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 { "finish": null, "pipeline_run_number": null, "pipeline_type": null, "record_count": null, "run_type": null, "start": null }
Was this section helpful?

What made this section unhelpful for you?

VendorMasterPipelineStats

VendorMasterPipelineStats

cumulative_number_of_records_matchedfloat Required
number_address_only_duplicatesfloat Required
number_name_and_address_duplicatesfloat Required
number_name_only_duplicatesfloat Required
number_of_hard_duplicatefloat Required
number_of_recordsfloat Required
number_of_records_droppedfloat Required
number_of_records_eligible_for_matchingfloat Required
number_of_records_failedfloat Required
number_of_records_hil_matchedfloat Required
number_of_records_matchedfloat Required
number_of_records_need_ambiguous_matchingfloat Required
number_of_records_not_matchedfloat Required
number_of_records_processingfloat Required
number_of_soft_duplicatefloat Required
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "cumulative_number_of_records_matched": null, "number_address_only_duplicates": null, "number_name_and_address_duplicates": null, "number_name_only_duplicates": null, "number_of_hard_duplicate": null, "number_of_records": null, "number_of_records_dropped": null, "number_of_records_eligible_for_matching": null, "number_of_records_failed": null, "number_of_records_hil_matched": null, "number_of_records_matched": null, "number_of_records_need_ambiguous_matching": null, "number_of_records_not_matched": null, "number_of_records_processing": null, "number_of_soft_duplicate": null }
Was this section helpful?

What made this section unhelpful for you?

Scalars

Scalars: Scalars in GraphQL represent primitive data types, such as String, Int, Boolean, Float, etc. They are used to define the types of individual fields in the GraphQL schema.

Enums

Enums in GraphQL define a set of possible values for a field. They represent a discrete set of options or states that a field can have. Enums help ensure type safety and provide a clear list of valid values for a field.