{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Syntage","colors":{"primary":"#1975FF","light":"#1975FF"},"logo":{"light":"https://mintcdn.com/syntage/NuYQc9gEjSxFZJMz/logo.svg?fit=max\u0026auto=format\u0026n=NuYQc9gEjSxFZJMz\u0026q=85\u0026s=976345a01e03638f59ea0f9cb2a7d8d3","dark":"https://mintcdn.com/syntage/Guui-PNq2RqcZDxJ/logo-dark.svg?fit=max\u0026auto=format\u0026n=Guui-PNq2RqcZDxJ\u0026q=85\u0026s=fb29ea6c7437fb18ca359ce2c22460f9"},"favicon":"https://mintcdn.com/syntage/UtiP7paDbtCUc-2P/favicon.ico?fit=max\u0026auto=format\u0026n=UtiP7paDbtCUc-2P\u0026q=85\u0026s=37b2c70e584adf9b64dedef8bd5fbabb","api":{"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.syntage.com"}},"navbar":{"links":[{"href":"https://support.syntage.com","label":"Support"}],"primary":{"type":"button","label":"Go to App","href":"https://app.syntage.com"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","aistudio","mcp","add-mcp","cursor","vscode","devin-mcp","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"es","href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"syntage","hasAudioNarration":false,"actualSubdomain":"syntage","customDomains":["docs.syntage.com"],"gitSource":{"type":"github","owner":"syntagecom","repo":"platform.backend","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4b153bfaae13da36b83a4","collectionId":"a96b18a5-8757-4ef9-9c64-2fd72eaf6618","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4b153bfaae13da36b83a4"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4b153bfaae13da36b83a4","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"en","tag":"API Reference","count":178},{"language":"en","tag":"Datasource: SAT","count":47},{"language":"en","tag":"Core Resources","count":42},{"language":"en","tag":"Resource Guide","count":40},{"language":"es","tag":"Guía de recursos","count":40},{"language":"en","tag":"Insights","count":32},{"language":"en","tag":"Invoices","count":32},{"language":"en","tag":"Datasources","count":28},{"language":"es","tag":"Fuentes de datos","count":28},{"language":"en","tag":"Other Resources","count":23},{"language":"en","tag":"Using Syntage","count":21},{"language":"es","tag":"Usar Syntage","count":21},{"language":"en","tag":"Entities","count":18},{"language":"es","tag":"SAT","count":14},{"language":"es","tag":"Dashboard","count":8},{"language":"es","tag":"Recursos principales","count":6},{"language":"es","tag":"Facturas","count":6},{"language":"es","tag":"Desarrolladores","count":5},{"language":"es","tag":"Comienza aquí","count":5},{"language":"es","tag":"Cómo funciona Syntage","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/schedulers/create-an-scheduler","slug":"/api-reference/schedulers/create-an-scheduler","pageMetadata":{"openapi":"post /schedulers","title":"Create a scheduler","description":"Create a scheduler that can run one or more extraction rules.","href":"/api-reference/schedulers/create-an-scheduler"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a scheduler that can run one or more extraction rules.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /schedulers","title":"Create a scheduler","description":"Create a scheduler that can run one or more extraction rules.","href":"/api-reference/schedulers/create-an-scheduler"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Schedulers"],"operationId":"CreateScheduler","summary":"Create a scheduler","description":"Create a scheduler that can run one or more extraction rules.","requestBody":"6db02a57-6dc4-4cfc-836f-1eb3cecac699","responses":{"202":"75a21cd9-4b93-4900-8f56-71f56ada1c2f","401":"1d2f3882-2033-4ecd-b761-765c833853be"},"method":"post","type":"path","servers":["c1b39701-ca57-46a3-bd83-d360d3ba21a8","169c4312-86fb-4185-b68e-62850504e10a"],"security":["d35d5279-aa6d-4b15-85fe-79bce9aeaac2"],"path":"/schedulers","baseUrlOptions":["https://api.syntage.com","https://api.sandbox.syntage.com"],"title":"Create a scheduler","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","writeOnly":true,"description":"Scheduler type; only `recurring` is allowed for creation","example":"recurring","enum":["recurring"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","writeOnly":true,"description":"Scheduler name; if omitted, the scheduler is created without a name","example":"Daily Invoices Scheduler","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","writeOnly":true,"description":"Scheduler name; if omitted, the scheduler is created without a name","example":"Daily Invoices Scheduler","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"isEnabled":{"type":"boolean","writeOnly":true,"description":"Whether the scheduler is enabled","example":true,"default":true,"uniqueKey":"isEnabled","typeLabel":"boolean"},"tags":{"type":"array","writeOnly":true,"description":"Entity tags to associate with the scheduler","example":["/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"],"items":{"type":"string","format":"iri-reference","uniqueKey":"tags.items.[INDEX]","typeLabel":"string\u003ciri-reference>"},"uniqueKey":"tags","typeLabel":"string\u003ciri-reference>[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"recurring","name":"Daily Invoices Scheduler","isEnabled":true,"tags":["/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"75a21cd9-4b93-4900-8f56-71f56ada1c2f":{"description":"Scheduler resource response","content":{"application/ld+json":{"schema":{"type":"object","properties":{"@context":{"type":"string","default":"/contexts/Scheduler","uniqueKey":"@context","typeLabel":"string"},"@id":{"type":"string","format":"iri-reference","description":"Scheduler IRI reference","example":"/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","description":"JSON-LD resource type","default":"Scheduler","uniqueKey":"@type","typeLabel":"string"},"id":{"type":"string","format":"uuid","example":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","example":"Daily Invoices Scheduler","description":"Scheduler name; may be null for first-time schedulers created automatically by the platform","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Daily Invoices Scheduler","description":"Scheduler name; may be null for first-time schedulers created automatically by the platform","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"type":{"type":"string","description":"Scheduler type","example":"recurring","enum":["recurring"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"isEnabled":{"type":"boolean","description":"Whether the scheduler is enabled","nullable":false,"example":true,"uniqueKey":"isEnabled","typeLabel":"boolean"},"rules":{"type":"object","properties":{"@context":{"type":"string","default":"/contexts/SchedulerRule","uniqueKey":"rules.@context","typeLabel":"string"},"@id":{"type":"string","default":"/schedulers/rules","uniqueKey":"rules.@id","typeLabel":"string"},"@type":{"type":"string","default":"hydra:Collection","uniqueKey":"rules.@type","typeLabel":"string"},"hydra:member":{"type":"array","items":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference","description":"Scheduler Rule IRI reference","example":"/schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"rules.hydra:member.items.[INDEX].@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","description":"JSON-LD resource type","default":"SchedulerRule","uniqueKey":"rules.hydra:member.items.[INDEX].@type","typeLabel":"string"},"id":{"type":"string","format":"uuid","example":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","uniqueKey":"rules.hydra:member.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"scheduler":{"type":"string","description":"Scheduler that owns this rule","example":"Daily Invoices Scheduler","nullable":false,"uniqueKey":"rules.hydra:member.items.[INDEX].scheduler","typeLabel":"string"},"extractor":{"type":"string","description":"Extractor to run, which retrieves resources from the corresponding datasource","enum":["invoice","monthly_tax_return","annual_tax_return","rif_tax_return","tax_status","tax_retention","tax_compliance","electronic_accounting","sat_certificates","rpc","buro_de_credito_report","bil","rug","background_check","infonavit"],"uniqueKey":"rules.hydra:member.items.[INDEX].extractor","typeLabel":"enum\u003cstring>"},"options":{"oneOf":[{"type":"object","title":"Invoice extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"period":{"title":"Extraction period","type":"object","additionalProperties":false,"properties":{"from":{"type":"string","description":"Start of the extraction period. Accepts a date or relative date expression. Defaults to the start of the year three years ago.","example":"2024-01-01","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.period.from","typeLabel":"string"},"to":{"type":"string","description":"End of the extraction period. Must be later than `from` and cannot be a future date. Defaults to the current date and time.","example":"2024-12-31","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.period.to","typeLabel":"string"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.period","typeLabel":"Extraction period · object"},"types":{"type":"array","description":"CFDI types to extract. Defaults to every supported type.","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["I","E","P","N","T"],"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["I","E","P"],"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.types","typeLabel":"enum\u003cstring>[]"},"issued":{"type":"boolean","description":"Whether to extract CFDIs issued by the entity.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.issued","typeLabel":"boolean"},"received":{"type":"boolean","description":"Whether to extract CFDIs received by the entity.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.received","typeLabel":"boolean"},"complement":{"type":"integer","description":"Complement filter passed to SAT.","default":-1,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.complement","typeLabel":"integer"},"pdf":{"type":"boolean","description":"Whether to download PDF files.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.pdf","typeLabel":"boolean"},"xml":{"type":"boolean","description":"Whether to download XML files.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0.xml","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.0","typeLabel":"Invoice extraction options · object"},{"type":"object","title":"Tax retention extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"period":{"title":"Extraction period","type":"object","additionalProperties":false,"properties":{"from":{"type":"string","description":"Start of the extraction period. Accepts a date or relative date expression. Defaults to the start of the year three years ago.","example":"2024-01-01","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.1.period.from","typeLabel":"string"},"to":{"type":"string","description":"End of the extraction period. Must be later than `from` and cannot be a future date. Defaults to the current date and time.","example":"2024-12-31","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.1.period.to","typeLabel":"string"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.1.period","typeLabel":"Extraction period · object"},"issued":{"type":"boolean","description":"Whether to extract tax retentions issued by the entity.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.1.issued","typeLabel":"boolean"},"received":{"type":"boolean","description":"Whether to extract tax retentions received by the entity.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.1.received","typeLabel":"boolean"},"complement":{"type":"integer","description":"Complement filter passed to SAT.","default":-1,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.1.complement","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.1","typeLabel":"Tax retention extraction options · object"},{"type":"object","title":"Annual tax return extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"period":{"title":"Extraction period","type":"object","additionalProperties":false,"properties":{"from":{"type":"string","description":"Start of the extraction period. Accepts a date or relative date expression. Defaults to the start of the year three years ago.","example":"2024-01-01","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.period.from","typeLabel":"string"},"to":{"type":"string","description":"End of the extraction period. Must be later than `from` and cannot be a future date. Defaults to the current date and time.","example":"2024-12-31","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.period.to","typeLabel":"string"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.period","typeLabel":"Extraction period · object"},"files":{"type":"object","additionalProperties":false,"description":"Tax return file types to download.","properties":{"tax_return.ack_receipt":{"type":"boolean","description":"Whether to download the filing acknowledgment receipt.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.files.tax_return\\.ack_receipt","typeLabel":"boolean"},"tax_return.transcript":{"type":"boolean","description":"Whether to download the tax return transcript.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.files.tax_return\\.transcript","typeLabel":"boolean"},"tax_return.payment_receipt":{"type":"boolean","description":"Whether to download the payment receipt.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.files.tax_return\\.payment_receipt","typeLabel":"boolean"},"tax_return.financial_statements":{"type":"boolean","description":"Whether to download financial statements.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.files.tax_return\\.financial_statements","typeLabel":"boolean"},"tax_return.audited_financial_statements":{"type":"boolean","description":"Whether to download audited financial statements.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.files.tax_return\\.audited_financial_statements","typeLabel":"boolean"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2.files","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.2","typeLabel":"Annual tax return extraction options · object"},{"type":"object","title":"Monthly tax return extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"period":{"title":"Extraction period","type":"object","additionalProperties":false,"properties":{"from":{"type":"string","description":"Start of the extraction period. Accepts a date or relative date expression. Defaults to the start of the year three years ago.","example":"2024-01-01","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.period.from","typeLabel":"string"},"to":{"type":"string","description":"End of the extraction period. Must be later than `from` and cannot be a future date. Defaults to the current date and time.","example":"2024-12-31","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.period.to","typeLabel":"string"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.period","typeLabel":"Extraction period · object"},"files":{"type":"object","additionalProperties":false,"description":"Tax return file types to download.","properties":{"tax_return.ack_receipt":{"type":"boolean","description":"Whether to download the filing acknowledgment receipt.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.files.tax_return\\.ack_receipt","typeLabel":"boolean"},"tax_return.transcript":{"type":"boolean","description":"Whether to download the tax return transcript.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.files.tax_return\\.transcript","typeLabel":"boolean"},"tax_return.payment_receipt":{"type":"boolean","description":"Whether to download the payment receipt.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.files.tax_return\\.payment_receipt","typeLabel":"boolean"},"tax_return.financial_statements":{"type":"boolean","description":"Whether to download financial statements.","default":true,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.files.tax_return\\.financial_statements","typeLabel":"boolean"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3.files","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.3","typeLabel":"Monthly tax return extraction options · object"},{"type":"object","title":"RIF tax return extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"period":{"title":"Extraction period","type":"object","additionalProperties":false,"properties":{"from":{"type":"string","description":"Start of the extraction period. Accepts a date or relative date expression. Defaults to the start of the year three years ago.","example":"2024-01-01","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.4.period.from","typeLabel":"string"},"to":{"type":"string","description":"End of the extraction period. Must be later than `from` and cannot be a future date. Defaults to the current date and time.","example":"2024-12-31","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.4.period.to","typeLabel":"string"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.4.period","typeLabel":"Extraction period · object"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.4","typeLabel":"RIF tax return extraction options · object"},{"type":"object","title":"Electronic accounting extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"period":{"title":"Extraction period","type":"object","additionalProperties":false,"properties":{"from":{"type":"string","description":"Start of the extraction period. Accepts a date or relative date expression. Defaults to the start of the year three years ago.","example":"2024-01-01","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.5.period.from","typeLabel":"string"},"to":{"type":"string","description":"End of the extraction period. Must be later than `from` and cannot be a future date. Defaults to the current date and time.","example":"2024-12-31","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.5.period.to","typeLabel":"string"}},"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.5.period","typeLabel":"Extraction period · object"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.5","typeLabel":"Electronic accounting extraction options · object"},{"type":"object","title":"RPC extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"nameThreshold":{"type":"number","format":"float","minimum":0.75,"maximum":1,"description":"Minimum name similarity for matching RPC entities. Higher values require a closer match. When omitted, the RPC datasource uses its default threshold of 0.75.","example":0.9,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.6.nameThreshold","typeLabel":"number\u003cfloat>"},"nameLimit":{"type":"integer","minimum":1,"maximum":100,"description":"Maximum number of matching RPC entities to return, ordered from most to least similar. When omitted, the RPC datasource uses its default page size.","example":25,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.6.nameLimit","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.6","typeLabel":"RPC extraction options · object"},{"type":"object","title":"Buró de Crédito report extraction options","description":"Options are specific to the selected extractor. Select the schema matching the extractor; extractors not listed here do not accept options.","properties":{"productType":{"type":"string","description":"Buró de Crédito product to request. Supported values depend on whether the entity is a person or company. When omitted, the organization's configured default applies.","enum":["007","004","INFORME_BURO","RCO"],"example":"INFORME_BURO","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.7.productType","typeLabel":"enum\u003cstring>"},"legalScoreCode":{"type":"string","description":"Score code used for a company report. The only supported value is `012`.","enum":["012"],"default":"012","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.7.legalScoreCode","typeLabel":"enum\u003cstring>"},"legalAmbiguity":{"type":"string","minLength":1,"description":"Ambiguity indicator saved with the extraction and used for a company report. When omitted, the organization's configured legal ambiguity applies, falling back to `R` when unset.","uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.7.legalAmbiguity","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"rules.hydra:member.items.[INDEX].options.oneOf.7","typeLabel":"Buró de Crédito report extraction options · object"}],"uniqueKey":"rules.hydra:member.items.[INDEX].options","typeLabel":"Invoice extraction options · object | Tax retention extraction options · object | Annual tax return extraction options · object | Monthly tax return extraction options · object | RIF tax return extraction options · object | Electronic accounting extraction options · object | RPC extraction options · object | Buró de Crédito report extraction options · object"},"cronExpression":{"oneOf":[{"type":"string","description":"Cron expression that controls when the rule runs","example":"@daily","uniqueKey":"rules.hydra:member.items.[INDEX].cronExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cron expression that controls when the rule runs","example":"@daily","uniqueKey":"rules.hydra:member.items.[INDEX].cronExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.hydra:member.items.[INDEX].cronExpression","typeLabel":"string | null"},"nextRunDate":{"type":"string","description":"Date and time the resource should execute in the next iteration","example":"2020-01-01T12:15:00.000Z","uniqueKey":"rules.hydra:member.items.[INDEX].nextRunDate","typeLabel":"string"},"createdAt":{"type":"string","description":"Date and time the resource was created","example":"2020-01-01T12:15:00.000Z","uniqueKey":"rules.hydra:member.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date and time the resource was last updated","example":"2020-01-01T12:15:00.000Z","uniqueKey":"rules.hydra:member.items.[INDEX].updatedAt","typeLabel":"string"}},"uniqueKey":"rules.hydra:member.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rules.hydra:member","typeLabel":"object[]"},"hydra:totalItems":{"type":"integer","description":"Total number of items found","minimum":0,"example":1,"uniqueKey":"rules.hydra:totalItems","typeLabel":"integer"},"hydra:view":{"type":"object","description":"Pagination information","properties":{"@id":{"type":"string","description":"Current page IRI reference","format":"iri-reference","example":"/schedulers/rules?page=1","uniqueKey":"rules.hydra:view.@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","default":"hydra:PartialCollectionView","uniqueKey":"rules.hydra:view.@type","typeLabel":"string"},"hydra:first":{"type":"string","description":"First page IRI reference; omitted when there is no pagination","format":"iri-reference","example":"/schedulers/rules?page=1","uniqueKey":"rules.hydra:view.hydra:first","typeLabel":"string\u003ciri-reference>"},"hydra:next":{"type":"string","description":"Next page IRI reference; omitted when there is no pagination","format":"iri-reference","example":"/schedulers/rules?page=2","uniqueKey":"rules.hydra:view.hydra:next","typeLabel":"string\u003ciri-reference>"},"hydra:last":{"type":"string","description":"Last page IRI reference; omitted when there is no pagination","format":"iri-reference","example":"/schedulers/rules?page=3","uniqueKey":"rules.hydra:view.hydra:last","typeLabel":"string\u003ciri-reference>"}},"uniqueKey":"rules.hydra:view","typeLabel":"object"},"hydra:search":{"type":"object","properties":{"@type":{"type":"string","uniqueKey":"rules.hydra:search.@type","typeLabel":"string"},"hydra:template":{"type":"string","uniqueKey":"rules.hydra:search.hydra:template","typeLabel":"string"},"hydra:variableRepresentation":{"type":"string","uniqueKey":"rules.hydra:search.hydra:variableRepresentation","typeLabel":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string","uniqueKey":"rules.hydra:search.hydra:mapping.items.[INDEX].@type","typeLabel":"string"},"variable":{"type":"string","uniqueKey":"rules.hydra:search.hydra:mapping.items.[INDEX].variable","typeLabel":"string"},"property":{"type":"string","uniqueKey":"rules.hydra:search.hydra:mapping.items.[INDEX].property","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"rules.hydra:search.hydra:mapping.items.[INDEX].required","typeLabel":"boolean"}},"uniqueKey":"rules.hydra:search.hydra:mapping.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rules.hydra:search.hydra:mapping","typeLabel":"object[]"}},"uniqueKey":"rules.hydra:search","typeLabel":"object"}},"uniqueKey":"rules","typeLabel":"object"},"tags":{"type":"array","items":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference","description":"Entity Tag IRI reference","example":"/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"tags.items.[INDEX].@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","description":"JSON-LD resource type","default":"EntityTag","uniqueKey":"tags.items.[INDEX].@type","typeLabel":"string"},"id":{"type":"string","format":"uuid","example":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","uniqueKey":"tags.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Display name for the entity tag","example":"Priority Entity","nullable":false,"uniqueKey":"tags.items.[INDEX].name","typeLabel":"string"},"color":{"oneOf":[{"type":"string","description":"Lowercase 7-character hexadecimal color used to display the tag (`#RRGGBB`). Defaults to `#a3aab5` when an entity tag is created without a color.","example":"#22c558","uniqueKey":"tags.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Lowercase 7-character hexadecimal color used to display the tag (`#RRGGBB`). Defaults to `#a3aab5` when an entity tag is created without a color.","example":"#22c558","uniqueKey":"tags.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags.items.[INDEX].color","typeLabel":"string | null"},"createdAt":{"type":"string","description":"Date and time the resource was created","example":"2020-01-01T12:15:00.000Z","uniqueKey":"tags.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date and time the resource was last updated","example":"2020-01-01T12:15:00.000Z","uniqueKey":"tags.items.[INDEX].updatedAt","typeLabel":"string"}},"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tags","typeLabel":"object[]"},"createdAt":{"type":"string","description":"Date and time the resource was created","example":"2020-01-01T12:15:00.000Z","uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date and time the resource was last updated","example":"2020-01-01T12:15:00.000Z","uniqueKey":"updatedAt","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"@context":"/contexts/Scheduler","@id":"/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997","@type":"Scheduler","id":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","name":"Daily Invoices Scheduler","type":"recurring","isEnabled":true,"rules":{"@context":"/contexts/SchedulerRule","@id":"/schedulers/rules","@type":"hydra:Collection","hydra:member":[{"@id":"/schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997","@type":"SchedulerRule","id":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","scheduler":"Daily Invoices Scheduler","extractor":"invoice","options":{"period":{"from":"2024-01-01","to":"2024-12-31"},"types":["I","E","P"],"issued":true,"received":true,"complement":-1,"pdf":true,"xml":true},"cronExpression":"@daily","nextRunDate":"2020-01-01T12:15:00.000Z","createdAt":"2020-01-01T12:15:00.000Z","updatedAt":"2020-01-01T12:15:00.000Z"}],"hydra:totalItems":1,"hydra:view":{"@id":"/schedulers/rules?page=1","@type":"hydra:PartialCollectionView","hydra:first":"/schedulers/rules?page=1","hydra:next":"/schedulers/rules?page=2","hydra:last":"/schedulers/rules?page=3"},"hydra:search":{"@type":"\u003cstring>","hydra:template":"\u003cstring>","hydra:variableRepresentation":"\u003cstring>","hydra:mapping":[{"@type":"\u003cstring>","variable":"\u003cstring>","property":"\u003cstring>","required":true}]}},"tags":[{"@id":"/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997","@type":"EntityTag","id":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","name":"Priority Entity","color":"#22c558","createdAt":"2020-01-01T12:15:00.000Z","updatedAt":"2020-01-01T12:15:00.000Z"}],"createdAt":"2020-01-01T12:15:00.000Z","updatedAt":"2020-01-01T12:15:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"1d2f3882-2033-4ecd-b761-765c833853be":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d35d5279-aa6d-4b15-85fe-79bce9aeaac2":{"ApiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","scopes":[],"schemeName":"ApiKey"}}},"servers":{"c1b39701-ca57-46a3-bd83-d360d3ba21a8":{"url":"https://api.syntage.com","description":"Production"},"169c4312-86fb-4185-b68e-62850504e10a":{"url":"https://api.sandbox.syntage.com","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-API-Key","type":"string","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-API-Key"}],"title":"ApiKey"}]},"originalFileLocation":"openapi/openapi.yaml"},"subdomain":"syntage","siteName":"Syntage","title":"Create a scheduler - Syntage","navMaps":{"firstHrefInVersion":{"2020-06-28":{"href":"/api-reference/schedulers/create-an-scheduler","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/api-reference/schedulers/create-an-scheduler","matchLevel":0},"es":{"href":"/es","matchLevel":4}}},"lastModified":"2026-06-16T18:31:11.772Z","originalFileLocation":"api-reference/schedulers/create-an-scheduler.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a scheduler that can run one or more extraction rules.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Syntage\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a scheduler - Syntage\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a scheduler that can run one or more extraction rules.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Syntage\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://syntage.mintlify.app/_mintlify/api/og/v2?division=Schedulers\u0026amp;title=Create+a+scheduler\u0026amp;description=Create+a+scheduler+that+can+run+one+or+more+extraction+rules.\u0026amp;theme=71db65a3f59ffd9e5f96cd77\u0026amp;signature=c454836336eb668dcffc819406f06cc0af1ef4d0ecb0bf4bb2ea2644fa44fad5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a scheduler - Syntage\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a scheduler that can run one or more extraction rules.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://syntage.mintlify.app/_mintlify/api/og/v2?division=Schedulers\u0026amp;title=Create+a+scheduler\u0026amp;description=Create+a+scheduler+that+can+run+one+or+more+extraction+rules.\u0026amp;theme=71db65a3f59ffd9e5f96cd77\u0026amp;signature=c454836336eb668dcffc819406f06cc0af1ef4d0ecb0bf4bb2ea2644fa44fad5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Syntage\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1975FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/schedulers/create-an-scheduler.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.syntage.com/#organization\",\"name\":\"Syntage\",\"url\":\"https://docs.syntage.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/syntage/NuYQc9gEjSxFZJMz/logo.svg?fit=max\u0026auto=format\u0026n=NuYQc9gEjSxFZJMz\u0026q=85\u0026s=976345a01e03638f59ea0f9cb2a7d8d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.syntage.com#website\",\"name\":\"Syntage\",\"url\":\"https://docs.syntage.com\",\"publisher\":{\"@id\":\"https://docs.syntage.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler#webpage\",\"url\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler\",\"name\":\"Create a scheduler\",\"description\":\"Create a scheduler that can run one or more extraction rules.\",\"dateModified\":\"2026-06-16T18:31:11.772Z\",\"isPartOf\":{\"@id\":\"https://docs.syntage.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core Resources\",\"item\":\"https://docs.syntage.com/api-reference/events/list-all-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Extractions\",\"item\":\"https://docs.syntage.com/api-reference/extractions/list-all-extractions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Schedulers\",\"item\":\"https://docs.syntage.com/api-reference/schedulers/list-schedulers\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Create a scheduler\",\"item\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler#apireference\",\"headline\":\"Create a scheduler\",\"name\":\"Create a scheduler\",\"description\":\"Create a scheduler that can run one or more extraction rules.\",\"url\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler\",\"mainEntityOfPage\":{\"@id\":\"https://docs.syntage.com/api-reference/schedulers/create-an-scheduler#webpage\"},\"dateModified\":\"2026-06-16T18:31:11.772Z\",\"publisher\":{\"@id\":\"https://docs.syntage.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.syntage.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Syntage\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Syntage","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Using Syntage","pages":[{"title":"Using Syntage","href":""}]},{"tab":"Resource Guide","pages":[{"title":"Resource Guide","href":"/resources/core/entities"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"API Reference","versions":[{"version":"2020-06-28","default":true,"pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"group":"Core Resources","pages":[{"group":"Events","pages":[{"openapi":"get /events","title":"List all events","href":"/api-reference/events/list-all-events"},{"openapi":"get /events/{id}","title":"Retrieve an event","href":"/api-reference/events/retrieve-an-event"}]},{"group":"Files","pages":[{"openapi":"get /files/{id}","title":"Retrieve a file","href":"/api-reference/files/retrieve-a-file"},{"openapi":"get /files/{id}/download","title":"Download content","href":"/api-reference/files/download-the-file-content"}]},{"group":"Exports","pages":[{"openapi":"post /exports","title":"Export data","href":"/api-reference/exports/export-data"},{"openapi":"get /exports","title":"List all exports","href":"/api-reference/exports/list-all-exports"},{"openapi":"get /exports/{id}","title":"Retrieve an export","href":"/api-reference/exports/retrieve-an-export"}]},{"group":"Entities","pages":[{"openapi":"get /entities","title":"List all entities","href":"/api-reference/entities/list-all-entities"},{"openapi":"post /entities","title":"Add an Entity","href":"/api-reference/entities/add-an-entity"},{"openapi":"get /entities/{entityId}","title":"Retrieve an Entity","href":"/api-reference/entities/retrieve-an-entity"},{"openapi":"patch /entities/{entityId}","title":"Update an Entity","href":"/api-reference/entities/update-an-entity"},{"openapi":"delete /entities/{entityId}","title":"Delete an Entity","href":"/api-reference/entities/delete-an-entity"},{"group":"Favorites","pages":[{"title":"Favorite one or more entities","openapi":"post /entities/favorites","href":"/api-reference/entities/favorite-multiple-entities"},{"title":"Unfavorite one or more entities","openapi":"delete /entities/favorites","href":"/api-reference/entities/unfavorite-multiple-entities"}]},{"group":"Events","pages":[{"openapi":"get /entities/{entityId}/events","title":"List an entity's events","href":"/api-reference/entities/list-an-entitys-events"}]},{"group":"Identifiers","pages":[{"openapi":"get /entities/{entityId}/identifiers","title":"List an entity's identifiers","href":"/api-reference/entities/list-an-entitys-identifiers"},{"openapi":"post /entities/{entityId}/identifiers","title":"Add an entity identifier","href":"/api-reference/entities/add-an-entity-identifier"}]},{"group":"Entity Tags","pages":[{"openapi":"get /entities/{entityId}/tags","title":"List an entity's tags","href":"/api-reference/entities/list-an-entitys-tags"},{"openapi":"get /entity-tags","title":"List all entity tags","href":"/api-reference/entities/list-all-entity-tags"},{"openapi":"post /entity-tags","title":"Create an entity tag","href":"/api-reference/entities/create-an-entity-tag"},{"openapi":"get /entity-tags/{id}","title":"Retrieve an entity tag","href":"/api-reference/entities/retrieve-an-entity-tag"},{"openapi":"patch /entity-tags/{id}","title":"Update an entity tag","href":"/api-reference/entities/update-an-entity-tag"},{"openapi":"delete /entity-tags/{id}","title":"Delete an entity tag","href":"/api-reference/entities/delete-an-entity-tag"},{"openapi":"post /entities/batch/tags","title":"Tag multiple entities","href":"/api-reference/entities/tag-multiple-entities"},{"openapi":"post /entities/batch/tags/remove","title":"Untag multiple entities","href":"/api-reference/entities/untag-multiple-entities"}]}]},{"group":"Tags","pages":[{"openapi":"get /tags","title":"List all tags","href":"/api-reference/tags/list-all-tags"},{"openapi":"post /tags","title":"Create a tag","href":"/api-reference/tags/create-a-tag"},{"openapi":"delete /tags/{id}","title":"Delete a tag","href":"/api-reference/tags/delete-a-tag"},{"openapi":"patch /tags/{id}","title":"Update a tag","href":"/api-reference/tags/update-a-tag"}]},{"group":"Extractions","pages":[{"openapi":"get /extractions","title":"List all extractions","href":"/api-reference/extractions/list-all-extractions"},{"openapi":"post /extractions","title":"Create an extraction","href":"/api-reference/extractions/create-an-extraction"},{"openapi":"get /extractions/{id}","title":"Retrieve an extraction","href":"/api-reference/extractions/retrieve-an-extraction"},{"openapi":"delete /extractions/{id}/stop","title":"Request the extraction to be stopped","href":"/api-reference/extractions/request-the-extraction-to-be-stopped"},{"group":"Schedulers","pages":[{"openapi":"get /schedulers","title":"List schedulers","description":"List all schedulers.\n","href":"/api-reference/schedulers/list-schedulers"},{"openapi":"post /schedulers","title":"Create a scheduler","href":"/api-reference/schedulers/create-an-scheduler"},{"openapi":"get /schedulers/{id}","title":"Retrieve a scheduler","description":"Retrieve a scheduler by ID, including its rules and tags.","href":"/api-reference/schedulers/retrieve-an-scheduler"},{"openapi":"put /schedulers/{id}","title":"Update a scheduler","href":"/api-reference/schedulers/update-an-scheduler"},{"openapi":"delete /schedulers/{id}","title":"Delete a scheduler","href":"/api-reference/schedulers/delete-an-scheduler"},{"group":"Rules","pages":[{"openapi":"post /schedulers/rules","title":"Create a scheduler rule","href":"/api-reference/scheduler-rules/create-an-scheduler-rule"},{"openapi":"get /schedulers/rules/{id}","title":"Retrieve a scheduler rule","href":"/api-reference/scheduler-rules/retrieve-an-scheduler-rule"},{"openapi":"put /schedulers/rules/{id}","title":"Update a scheduler rule","href":"/api-reference/scheduler-rules/update-an-scheduler-rule"},{"openapi":"delete /schedulers/rules/{id}","title":"Delete a scheduler rule","href":"/api-reference/scheduler-rules/delete-an-scheduler-rule"}]}]}]}]},{"group":"Other Resources","pages":[{"group":"Shareholders","pages":[{"openapi":"get /entities/{entityId}/shareholders","title":"List an entity's shareholders","href":"/api-reference/shareholders/get-an-entitys-shareholders"},{"openapi":"post /entities/{entityId}/shareholders","title":"Create a new shareholder for an entity","href":"/api-reference/shareholders/create-a-new-shareholder-for-an-entity"},{"openapi":"get /shareholders","title":"List shareholders","href":"/api-reference/shareholders/get-all-shareholders"},{"openapi":"get /shareholders/{id}","title":"Retrieve a shareholder","href":"/api-reference/shareholders/get-a-specific-shareholder"},{"openapi":"patch /shareholders/{id}","title":"Update a shareholder","href":"/api-reference/shareholders/update-a-shareholder"},{"openapi":"delete /shareholders/{id}","title":"Delete a shareholder","href":"/api-reference/shareholders/delete-a-shareholder"},{"group":"Relations","pages":[{"openapi":"get /shareholders/{shareholderId}/relations","title":"List shareholder relations","href":"/api-reference/shareholders/get-shareholder-relations"},{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}","title":"Retrieve a shareholder relation","href":"/api-reference/shareholders/get-a-specific-shareholder-relation"},{"openapi":"patch /shareholders/{shareholderId}/relations/{relationId}","title":"Update a shareholder relation","href":"/api-reference/shareholders/update-a-shareholder-relation"},{"openapi":"delete /shareholders/{shareholderId}/relations/{relationId}","title":"Delete a shareholder relation","href":"/api-reference/shareholders/delete-a-shareholder-relation"},{"openapi":"post /shareholders/{shareholderId}/relations/{relationId}/promote","title":"Promote a shareholder relation","href":"/api-reference/shareholders/promote-a-shareholder-relation"}]},{"group":"Sources","pages":[{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}/sources","title":"List shareholder relation sources","href":"/api-reference/shareholders/get-shareholder-relation-sources"},{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}","title":"Retrieve a shareholder relation source","href":"/api-reference/shareholders/get-a-specific-shareholder-relation-source"},{"openapi":"delete /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}","title":"Delete a shareholder relation source","href":"/api-reference/shareholders/delete-a-shareholder-relation-source"}]}]},{"group":"Background Checks","pages":[{"openapi":"get /background-checks","title":"List background checks","href":"/api-reference/background-checks/get-all-background-checks"},{"openapi":"get /background-checks/{id}","title":"Retrieve a background check","href":"/api-reference/background-checks/get-a-specific-background-check"},{"openapi":"get /background-checks/{id}/pdf","title":"Download background check PDF","href":"/api-reference/background-checks/get-background-check-pdf-report"},{"openapi":"get /entities/{entityId}/background-checks","title":"List an entity's background checks","href":"/api-reference/background-checks/get-an-entitys-background-checks"},{"openapi":"get /background-checks/{backgroundCheckId}/records","title":"List background check records","href":"/api-reference/background-checks/get-background-check-records"}]},{"group":"Company Verification Reports","pages":[{"openapi":"get /datasources/mx/company-verification/reports","title":"List company verification reports","href":"/api-reference/company-verification-reports/get-all-company-verification-reports"},{"openapi":"get /datasources/mx/company-verification/reports/{id}","title":"Retrieve a company verification report","href":"/api-reference/company-verification-reports/get-a-specific-company-verification-report"},{"openapi":"get /entities/{entityId}/datasources/mx/company-verification/reports","title":"List an entity's company verification reports","href":"/api-reference/company-verification-reports/get-an-entitys-company-verification-reports"}]},{"group":"Mexico Addresses","pages":[{"title":"Retrieve addresses by postal code","openapi":"get /datasources/mx/addresses/{postalCode}","href":"/api-reference/mexico-addresses/retrieve-addresses-by-postal-code"}]}]},{"group":"Datasource: SAT","pages":[{"group":"Credentials","pages":[{"openapi":"get /credentials","title":"List all credentials","href":"/api-reference/ds-mx-sat-credentials/list-all-credentials"},{"openapi":"post /credentials","title":"Create a credential","href":"/api-reference/ds-mx-sat-credentials/create-a-credential"},{"openapi":"get /credentials/{id}","title":"Retrieve a credential","href":"/api-reference/ds-mx-sat-credentials/retrieve-a-credential"},{"openapi":"delete /credentials/{id}","title":"Delete a credential","href":"/api-reference/ds-mx-sat-credentials/delete-a-credential"},{"openapi":"post /credentials/{id}/revalidate","title":"Revalidate a credential","href":"/api-reference/ds-mx-sat-credentials/revalidate-a-credential"}]},{"group":"Invoices","pages":[{"openapi":"get /invoices/{id}","title":"Retrieve an invoice","href":"/api-reference/ds-mx-sat-invoices/retrieve-an-invoice"},{"openapi":"post /invoices/{id}/tags","title":"Tag an invoice","href":"/api-reference/ds-mx-sat-invoices/tag-an-invoice"},{"openapi":"delete /invoices/{invoiceId}/tags/{tagId}","title":"Untag an invoice","href":"/api-reference/ds-mx-sat-invoices/untag-an-invoice"},{"openapi":"post /invoices/batch/tags","title":"Tag multiple invoices","href":"/api-reference/ds-mx-sat-invoices/tag-multiple-invoices"},{"openapi":"post /invoices/batch/tags/remove","title":"Untag multiple invoices","href":"/api-reference/ds-mx-sat-invoices/untag-multiple-invoices"},{"openapi":"get /invoices/{id}/cfdi","title":"Retrieve an invoice's CFDI","href":"/api-reference/ds-mx-sat-invoices/retrieve-an-invoices-cfdi"},{"openapi":"get /datasources/mx/sat/cfdis/{uuid}","title":"Retrieve a SAT CFDI","href":"/api-reference/ds-mx-sat-invoices/retrieve-a-sat-cfdi"},{"openapi":"get /entities/{entityId}/invoices","title":"List an entity's invoices","href":"/api-reference/ds-mx-sat-invoices/list-all-entities-invoices"},{"group":"Line Items","pages":[{"openapi":"get /invoices/line-items/{id}","title":"Retrieve an invoice line item","href":"/api-reference/ds-mx-sat-invoice-line-items/retrieve-an-invoice-line-item"},{"openapi":"get /invoices/{invoiceId}/line-items","title":"List an invoice's line items","href":"/api-reference/ds-mx-sat-invoice-line-items/list-an-invoices-line-items"},{"openapi":"get /entities/{entityId}/invoices/line-items","title":"List an entity's invoice line items","href":"/api-reference/ds-mx-sat-invoice-line-items/list-all-entity-line-items"}]},{"group":"Relations","pages":[{"openapi":"get /invoices/relations/{id}","title":"Retrieve an invoice relation","href":"/api-reference/ds-mx-sat-invoice-relations/retrieve-an-invoice-relation"},{"openapi":"get /invoices/{invoiceId}/relations","title":"List an invoice's relations","href":"/api-reference/ds-mx-sat-invoice-relations/list-an-invoices-relations"},{"openapi":"get /entities/{entityId}/invoices/{invoiceId}/relations","title":"List an entity's invoice relations","href":"/api-reference/ds-mx-sat-invoice-relations/list-an-entitys-invoice-relations"}]},{"group":"Payments","pages":[{"openapi":"get /invoices/payments","title":"List all invoice payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-all-invoice-payments"},{"openapi":"get /invoices/payments/{id}","title":"Retrieve an invoice payment","href":"/api-reference/ds-mx-sat-invoice-payments/retrieve-an-invoice-payment"},{"openapi":"get /invoices/{id}/payments","title":"List an invoice's payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-an-invoices-payments"},{"openapi":"get /entities/{entityId}/invoices/payments","title":"List an entity's invoice payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-entities-invoice-payments"},{"group":"Batch Payments","pages":[{"openapi":"get /invoices/batch-payments","title":"List all invoice batch payments","href":"/api-reference/ds-mx-sat-invoice-batch-payments/list-all-invoice-batch-payments"},{"openapi":"get /invoices/batch-payments/{id}","title":"Retrieve an invoice batch payment","href":"/api-reference/ds-mx-sat-invoice-batch-payments/retrieve-an-invoice-batch-payment"},{"openapi":"get /invoices/{id}/batch-payments","title":"List an invoice's batch payments","href":"/api-reference/ds-mx-sat-invoice-batch-payments/list-an-invoices-batch-payments"}]}]},{"group":"Credit Notes","pages":[{"openapi":"get /invoices/credit-notes","title":"List credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-credit-notes"},{"openapi":"get /entities/{entityId}/invoices/credit-notes","title":"List an entity's credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-an-entitys-credit-notes"},{"openapi":"get /invoices/credit-notes/{id}","title":"Retrieve an invoice credit note","href":"/api-reference/ds-mx-sat-credit-notes/retrieve-an-invoice-credit-note"},{"openapi":"get /invoices/{invoiceId}/issued-credit-notes","title":"List an invoice's issued credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-all-issued-credit-notes-related-to-the-requested-invoice"},{"openapi":"get /invoices/{invoiceId}/applied-credit-notes","title":"List an invoice's applied credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-all-applied-credit-notes-related-to-the-requested-invoice"}]}]},{"group":"Tax Retentions","pages":[{"openapi":"get /tax-retentions/{id}","title":"Retrieve a tax retention","href":"/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention"},{"openapi":"get /tax-retentions/{id}/cfdi","title":"Retrieve a tax retention CFDI","href":"/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention-cfdi"},{"openapi":"get /entities/{entityId}/tax-retentions","title":"List an entity's tax retentions","href":"/api-reference/ds-mx-sat-tax-retentions/list-all-entities-tax-retentions"}]},{"group":"Tax Returns","pages":[{"openapi":"get /tax-returns/{id}","title":"Retrieve a tax return","href":"/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return"},{"openapi":"get /tax-returns/{id}/pdf","title":"Download a tax return PDF","href":"/api-reference/ds-mx-sat-tax-returns/download-a-tax-return-pdf"},{"openapi":"get /tax-returns/{id}/data","title":"Retrieve tax return data","href":"/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return-data"},{"openapi":"get /entities/{entityId}/tax-returns","title":"List an entity's tax returns","href":"/api-reference/ds-mx-sat-tax-returns/list-all-entities-tax-returns"}]},{"group":"Tax Compliance Checks","pages":[{"openapi":"get /tax-compliance-checks/{id}","title":"Retrieve a tax compliance check","href":"/api-reference/ds-mx-sat-tax-compliance-checks/retrieve-a-tax-compliance-check"},{"openapi":"get /entities/{entityId}/tax-compliance-checks","title":"List an entity's tax compliance checks","href":"/api-reference/ds-mx-sat-tax-compliance-checks/list-all-entities-tax-compliance-checks"}]},{"group":"Tax Status","pages":[{"openapi":"get /tax-status","title":"List tax status records","href":"/api-reference/ds-mx-sat-tax-status/list-tax-status-records"},{"openapi":"get /tax-status/{id}","title":"Retrieve a tax status","href":"/api-reference/ds-mx-sat-tax-status/retrieve-a-tax-status"},{"openapi":"get /entities/{entityId}/tax-status","title":"List an entity's tax status records","href":"/api-reference/ds-mx-sat-tax-status/list-all-entities-tax-status"}]},{"group":"Electronic Accounting","pages":[{"openapi":"get /electronic-accounting-records/{id}","title":"Retrieve an electronic accounting record","href":"/api-reference/ds-mx-sat-electronic-accounting/retrieve-an-electronic-accounting-record"},{"openapi":"get /entities/{entityId}/electronic-accounting-records","title":"List an entity's electronic accounting records","href":"/api-reference/ds-mx-sat-electronic-accounting/list-all-entities-electronic-accounting-records"}]},{"group":"Certificates","pages":[{"openapi":"get /datasources/mx/sat/certificados/{id}","title":"Retrieve a SAT certificate","href":"/api-reference/ds-mx-sat-certificates/retrieve-a-sat-certificate"},{"openapi":"get /entities/{entityId}/datasources/mx/sat/certificados","title":"List an entity's SAT certificates","href":"/api-reference/ds-mx-sat-certificates/list-an-entitys-sat-certificates"}]}]},{"group":"Datasource: RPC","pages":[{"group":"Entidades","pages":[{"openapi":"get /datasources/mx/rpc/entidades/{id}","title":"Retrieve RPC entidade","href":"/api-reference/ds-mx-rpc-entidades/retrieve-rpc-entidades-data-beta"},{"openapi":"get /entities/{entityId}/datasources/mx/rpc/entidades","title":"List an entity's RPC entidades","href":"/api-reference/ds-mx-rpc-entidades/list-all-entities-rpc-entidades-data-beta"}]},{"group":"Actos","pages":[{"openapi":"get /rpc/actos/{id}","title":"Retrieve RPC acto","href":"/api-reference/ds-mx-rpc-actos/retrieve-an-rpc-acto"},{"openapi":"get /entities/{entityId}/datasources/mx/rpc/actos","title":"List an entity's RPC actos","href":"/api-reference/ds-mx-rpc-actos/list-an-entitys-rpc-actos"}]},{"group":"Socios","pages":[{"openapi":"get /datasources/rpc/socios/{id}","title":"Retrieve RPC socio","href":"/api-reference/ds-mx-rpc-socios/retrieve-an-rpc-socio"}]}]},{"group":"Datasource: RUG","pages":[{"group":"Operaciones","pages":[{"openapi":"get /datasources/rug/operaciones/{id}","title":"Retrieve RUG operation","href":"/api-reference/ds-mx-rug-operaciones/retrieve-rug-operacion-data"},{"openapi":"get /entities/{entityId}/datasources/rug/operaciones","title":"List an entity's RUG operations","href":"/api-reference/ds-mx-rug-operaciones/list-all-entities-rug-operaciones-data"}]},{"group":"Garantias","pages":[{"openapi":"get /datasources/rug/garantias/{id}","title":"Retrieve RUG guarantee","href":"/api-reference/ds-mx-rug-garantias/retrieve-rug-garantia-data"},{"openapi":"get /entities/{entityId}/datasources/rug/garantias","title":"List an entity's RUG guarantees","href":"/api-reference/ds-mx-rug-garantias/list-all-entities-rug-garantias-data-beta"}]}]},{"group":"Datasource: Syntage","pages":[{"group":"Score","pages":[{"openapi":"post /entities/{entityId}/datasources/syntage/score/calculate","title":"Start Syntage Score calculation","href":"/api-reference/ds-syntage-score/calculate-syntage-score"}]}]},{"group":"Datasource: Buró de Crédito","pages":[{"group":"Reports","pages":[{"openapi":"get /entities/{entityId}/datasources/mx/buro-de-credito/reports","title":"Get an entity's Buró de Crédito reports","href":"/api-reference/ds-mx-buro-de-credito-reports/get-an-entitys-buro-de-credito-reports"},{"openapi":"get /datasources/mx/buro-de-credito/reports/{id}","title":"Get a Buró de Crédito report","href":"/api-reference/ds-mx-buro-de-credito-reports/get-a-buro-de-credito-report"}]},{"group":"Authorizations","pages":[{"openapi":"get /datasources/mx/buro-de-credito/authorizations","title":"Get Buró de Crédito authorizations","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-all-buro-de-credito-authorizations"},{"openapi":"get /entities/{entityId}/datasources/mx/buro-de-credito/authorizations","title":"Get an entity's Buró de Crédito authorizations","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-an-entitys-buro-de-credito-authorizations"},{"openapi":"post /entities/{entityId}/datasources/mx/buro-de-credito/authorizations","title":"Create a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/create-a-buro-de-credito-authorization"},{"openapi":"get /datasources/mx/buro-de-credito/authorizations/{id}","title":"Get a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-a-buro-de-credito-authorization"},{"openapi":"delete /datasources/mx/buro-de-credito/authorizations/{id}","title":"Delete a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/delete-a-buro-de-credito-authorization"}]}]},{"group":"Datasource: BIL","pages":[{"group":"Reports","pages":[{"openapi":"get /entities/{entityId}/datasources/bil/reports","title":"List an entity's BIL reports","href":"/api-reference/ds-mx-bil-reports/list-an-entitys-bil-reports"},{"openapi":"get /datasources/bil/reports/{id}","title":"Retrieve a BIL report","href":"/api-reference/ds-mx-bil-reports/retrieve-a-bil-report"}]}]},{"group":"Datasource: Infonavit","pages":[{"group":"Overdue Credits","pages":[{"openapi":"get /entities/{entityId}/datasources/infonavit/overdue-credits","title":"List an entity's Infonavit overdue credits","href":"/api-reference/ds-mx-infonavit-overdue-credits/list-an-entitys-infonavit-overdue-credits"},{"openapi":"get /datasources/infonavit/overdue-credits/{id}","title":"Retrieve an Infonavit overdue credit","href":"/api-reference/ds-mx-infonavit-overdue-credits/retrieve-an-infonavit-overdue-credit"}]}]},{"group":"Insights","pages":[{"group":"Company","pages":[{"title":"Summary Insight","openapi":"get /entities/{entityId}/insights/summary","href":"/api-reference/summary-insight/get-summary"},{"title":"Scores Insight","openapi":"get /entities/{entityId}/insights/metrics/scores","href":"/api-reference/scores-insight/get-scores"},{"title":"Syntage Score Distribution","openapi":"get /insights/metrics/scores/syntage/distribution","href":"/api-reference/scores-insight/get-syntage-score-distribution"},{"title":"Buró de Crédito Summary Insight","openapi":"get /entities/{entityId}/insights/metrics/buro-de-credito/summary","href":"/api-reference/buro-de-credito-summary-insight/get-buro-de-credito-summary"},{"title":"Buró de Crédito Summary Export","openapi":"get /entities/{entityId}/insights/metrics/buro-de-credito/summary/export","href":"/api-reference/buro-de-credito-summary-insight/export-buro-de-credito-summary"},{"title":"Risks Insight","openapi":"get /entities/{entityId}/insights/risks","href":"/api-reference/risks-insight/get-risk-calculations"},{"title":"RPC Shareholders Insight","openapi":"get /entities/{entityId}/insights/rpc-shareholders","deprecated":true,"href":"/api-reference/rpc-shareholders-insight/get-rpc-shareholders-beta"}]},{"group":"Corporate Structure","pages":[{"title":"Shareholders Insight","openapi":"get /entities/{entityId}/insights/shareholders","href":"/api-reference/shareholders-insight/get-shareholders"},{"title":"Current Powers Insight","openapi":"get /entities/{entityId}/insights/corporate-structure/current-powers","href":"/api-reference/corporate-structure-current-powers-insight/get-current-powers"}]},{"group":"Revenue","pages":[{"title":"Invoicing Annual Comparison Insight","openapi":"get /entities/{entityId}/insights/metrics/invoicing-annual-comparison","href":"/api-reference/invoicing-annual-comparison-insight/get-invoicing-annual-comparison-insight"},{"title":"Sales Revenue Insight","openapi":"get /entities/{entityId}/insights/sales-revenue","href":"/api-reference/sales-revenue-insight/get-sales-revenue"},{"title":"Expenditures Insight","openapi":"get /entities/{entityId}/insights/expenditures","href":"/api-reference/expenditures-insight/get-expenditures"},{"title":"Cash Flow Insight","openapi":"get /entities/{entityId}/insights/cash-flow-stats","href":"/api-reference/cash-flow-insight/get-cash-flow"},{"title":"Moratory Interest Insight","openapi":"get /entities/{entityId}/insights/moratory-interest","href":"/api-reference/moratory-interest-insight/get-moratory-interest"},{"title":"Accounts Payable Insight","openapi":"get /entities/{entityId}/insights/accounts-payable","href":"/api-reference/accounts-payable-insight/get-accounts-payable"},{"title":"Accounts Receivable Insight","openapi":"get /entities/{entityId}/insights/accounts-receivable","href":"/api-reference/accounts-receivable-insight/get-accounts-receivable"},{"title":"Invoicing Blacklist Insight","openapi":"get /entities/{entityId}/insights/invoicing-blacklist","href":"/api-reference/invoicing-blacklist-insight/get-invoicing-blacklist"}]},{"group":"Financial","pages":[{"title":"Balance Sheet Insight","openapi":"get /entities/{entityId}/insights/metrics/balance-sheet","href":"/api-reference/balance-sheet-insight/get-balance-sheet-metric"},{"title":"Income Statement Insight","openapi":"get /entities/{entityId}/insights/metrics/income-statement","href":"/api-reference/income-statement-insight/get-metrics-income-statement"},{"title":"Financial Ratios Insight","openapi":"get /entities/{entityId}/insights/financial-ratios","href":"/api-reference/financial-ratios-insight/get-financial-ratios"},{"title":"Trial Balance Insight","openapi":"get /entities/{entityId}/insights/trial-balance","href":"/api-reference/trial-balance-insight/get-trial-balance"}]},{"group":"Clients","pages":[{"title":"Customer Concentration Insight","openapi":"get /entities/{entityId}/insights/customer-concentration","href":"/api-reference/customer-concentration-insight/get-customer-invoice-concentration"},{"title":"Customer Network Insight","openapi":"get /entities/{entityId}/insights/metrics/customer-network","href":"/api-reference/customer-network-insight/get-customer-network-insight"},{"title":"Products and Services Sold Insight","openapi":"get /entities/{entityId}/insights/products-and-services-sold","href":"/api-reference/products-and-services-sold-insight/get-products-and-services-sold"},{"title":"Government Customers Insight","openapi":"get /entities/{entityId}/insights/government-customers","href":"/api-reference/government-customers-insight/get-government-customers"}]},{"group":"Providers","pages":[{"title":"Vendor Concentration Insight","openapi":"get /entities/{entityId}/insights/supplier-concentration","href":"/api-reference/vendor-concentration-insight/get-vendor-invoice-concentration"},{"title":"Vendor Network Insight","openapi":"get /entities/{entityId}/insights/metrics/vendor-network","href":"/api-reference/vendor-network-insight/get-vendor-network-insight"},{"title":"Products and Services Bought Insight","openapi":"get /entities/{entityId}/insights/products-and-services-bought","href":"/api-reference/products-and-services-bought-insight/get-products-and-services-bought"},{"title":"Financial Institutions Insight","openapi":"get /entities/{entityId}/insights/financial-institutions","href":"/api-reference/financial-institutions-insight/get-financial-institutions"},{"title":"Employees Insight","openapi":"get /entities/{entityId}/insights/employees","href":"/api-reference/employees-insight/get-employees"}]},{"title":"Invoicing Concentration Insight","openapi":"get /entities/{entityId}/insights/invoicing-concentration","deprecated":true,"href":"/api-reference/invoicing-concentration-insight/get-invoicing-concentration"},{"title":"Insight Export","openapi":"get /entities/{entityId}/insights/{insight}/export","href":"/api-reference/insights/export-an-insight"}]},{"group":"Reports","pages":[{"openapi":"get /reports","title":"List all reports","href":"/api-reference/reports/list-reports"},{"openapi":"post /reports","title":"Create a report","href":"/api-reference/reports/create-a-report"},{"openapi":"get /reports/{id}","title":"Retrieve a report","href":"/api-reference/reports/retrieve-a-report"},{"openapi":"put /reports/{id}","title":"Update a report","href":"/api-reference/reports/update-a-report"},{"openapi":"delete /reports/{id}","title":"Delete a report","href":"/api-reference/reports/delete-a-report"}]},{"group":"Webhooks","pages":[{"group":"Webhook Endpoints","pages":[{"openapi":"get /webhook-endpoints","title":"List webhook endpoints","href":"/api-reference/webhook-endpoints/list-all-webhook-endpoints"},{"openapi":"post /webhook-endpoints","title":"Create webhook endpoint","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"openapi":"get /webhook-endpoints/{id}","title":"Retrieve webhook endpoint","href":"/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"openapi":"put /webhook-endpoints/{id}","title":"Update webhook endpoint","href":"/api-reference/webhook-endpoints/update-an-webhook-endpoint"},{"openapi":"delete /webhook-endpoints/{id}","title":"Delete webhook endpoint","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"}]},{"group":"Webhook Requests","pages":[{"openapi":"get /webhook-requests","title":"List webhook requests","href":"/api-reference/webhook-requests/list-all-webhook-requests"},{"openapi":"get /webhook-requests/{id}","title":"Retrieve webhook request","href":"/api-reference/webhook-requests/retrieve-a-webhook-request"}]}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"language":"es","pages":[{"title":"es","href":"/es"}]}]},"basePath":"","title":"Create a scheduler - Syntage","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}