Create an scheduler

curl --request POST \
  --url https://api.syntage.com/schedulers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Daily Invoices Scheduler",
  "type": "recurring",
  "isEnabled": true,
  "tags": [
    "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"
  ]
}
'

{
  "@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": {
          "types": [
            "I",
            "E",
            "P"
          ],
          "period": {
            "from": "2020-01-01T00:00:00.000Z",
            "to": "2020-03-31T23:59:59.000Z"
          }
        },
        "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": "<string>",
      "hydra:template": "<string>",
      "hydra:variableRepresentation": "<string>",
      "hydra:mapping": [
        {
          "@type": "<string>",
          "variable": "<string>",
          "property": "<string>",
          "required": true
        }
      ]
    }
  },
  "tags": [
    {
      "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "EntityTag",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "name": "Important Taxpayer",
      "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"
}

POST

schedulers

Create an scheduler

curl --request POST \
  --url https://api.syntage.com/schedulers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Daily Invoices Scheduler",
  "type": "recurring",
  "isEnabled": true,
  "tags": [
    "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"
  ]
}
'

{
  "@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": {
          "types": [
            "I",
            "E",
            "P"
          ],
          "period": {
            "from": "2020-01-01T00:00:00.000Z",
            "to": "2020-03-31T23:59:59.000Z"
          }
        },
        "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": "<string>",
      "hydra:template": "<string>",
      "hydra:variableRepresentation": "<string>",
      "hydra:mapping": [
        {
          "@type": "<string>",
          "variable": "<string>",
          "property": "<string>",
          "required": true
        }
      ]
    }
  },
  "tags": [
    {
      "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "EntityTag",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "name": "Important Taxpayer",
      "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"
}

Authorizations

X-API-Key

string

header

required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json

name

string

required

The scheduler name

Example:

"Daily Invoices Scheduler"

type

enum<string>

required

The type of scheduler, only the recurring type is allowed for creation

Available options:

recurring

Example:

"recurring"

isEnabled

boolean

default:true

To enable or disable the scheduler

Example:

true

Response

Scheduler resource response

@context

string

default:/contexts/Scheduler

@id

string<iri-reference>

Scheduler IRI reference

Example:

"/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997"

@type

string

default:Scheduler

string<uuid>

Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

name

string

Example:

"Daily Invoices Scheduler"

type

enum<string>

Available options:

recurring

Example:

"recurring"

isEnabled

boolean

rules

object

Show child attributes

rules.@context

string

default:/contexts/SchedulerRule

rules.@id

string

default:/schedulers/rules

rules.@type

string

default:hydra:Collection

rules.hydra:member

object[]

Show child attributes

rules.hydra:member.@id

string<iri-reference>

Scheduler Rule IRI reference

Example:

"/schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997"

rules.hydra:member.@type

string

default:SchedulerRule

rules.hydra:member.id

string<uuid>

Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

rules.hydra:member.scheduler

string

Example:

"Daily Invoices Scheduler"

rules.hydra:member.extractor

enum<string>

The extractor to be executed. Extracts various resources from the corresponding datasources.

Available options:

invoice,

monthly_tax_return,

annual_tax_return,

rif_tax_return,

tax_status,

tax_retention,

tax_compliance,

electronic_accounting,

rpc,

buro_de_credito_report,

bil,

rug

rules.hydra:member.options

object

The extractor options. Check the available options for each extractor in Extractions.

Example:

{
  "types": ["I", "E", "P"],
  "period": {
    "from": "2020-01-01T00:00:00.000Z",
    "to": "2020-03-31T23:59:59.000Z"
  }
}

rules.hydra:member.cronExpression

string | null

Example:

"@daily"

rules.hydra:member.nextRunDate

string

Date and time the resource should execute in the next iteration

Example:

"2020-01-01T12:15:00.000Z"

rules.hydra:member.createdAt

string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

rules.hydra:member.updatedAt

string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

rules.hydra:totalItems

integer

The total number of items found

Required range: x >= 0

Example:

1

rules.hydra:view

object

Pagination information

Show child attributes

rules.hydra:view.@id

string<iri-reference>

Current page IRI reference

Example:

"/schedulers/rules?page=1"

rules.hydra:view.@type

string

default:hydra:PartialCollectionView

rules.hydra:view.hydra:first

string<iri-reference>

First page IRI reference. This property is omitted if there is no pagination.

Example:

"/schedulers/rules?page=1"

rules.hydra:view.hydra:next

string<iri-reference>

Next page IRI reference. This property is omitted if there is no pagination.

Example:

"/schedulers/rules?page=2"

rules.hydra:view.hydra:last

string<iri-reference>

Last page IRI reference. This property is omitted if there is no pagination.

Example:

"/schedulers/rules?page=3"

rules.hydra:search

object

Show child attributes

rules.hydra:search.@type

string

rules.hydra:search.hydra:template

string

rules.hydra:search.hydra:variableRepresentation

string

rules.hydra:search.hydra:mapping

object[]

Show child attributes

rules.hydra:search.hydra:mapping.@type

string

rules.hydra:search.hydra:mapping.variable

string

rules.hydra:search.hydra:mapping.property

string

rules.hydra:search.hydra:mapping.required

boolean

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

Miscellaneous

Create an scheduler

Authorizations

Body

Response