Reports group entity insights into a configurable layout. A report is rendered in the dashboard's Reports section and can be downloaded as a PDF document with the [Exports API](/api-reference/exports/export-data). Built-in reports are created and kept up to date by Syntage and cannot be modified or deleted. Custom reports are personal by default; organizational reports are shared with every user in the organization.
openapi: 3.0.2
info:
version: '2020-06-28'
title: Syntage Accounts Payable Insight Reports API
contact:
name: Email
email: support@syntage.com
description: "# Introduction\n\nThe Syntage API is organized around [REST](https://en.wikipedia.org/wiki/Representational_State_Transfer).\nOur API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns [JSON-LD](https://json-ld.org) responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Environments\n\n| Name | Description | Base URL |\n|------|-------------|----------|\n| **Sandbox** | The Sandbox environment is dedicated to development and testing. In this environment, no real taxpayer credentials are required and all interaction with the SAT is simulated generating life-like data, allowing you to pull test data from all endpoints. | https://api.sandbox.syntage.com |\n| **Production** | The Production environment is dedicated to live applications with real connections to the SAT. In this environment, real taxpayer credentials are required, and you will pull real fiscal data directly from the SAT. | https://api.syntage.com |\n\nEach environment has a different API Key for [authentication](#section/Authentication).\n\n# Request IDs\n\nEach API request has an associated request identifier.\nYou can find this value in the response headers, under `X-Request-ID`:\n\n```curl\ncurl -i https://api.syntage.com\nHTTP/1.1 200 OK\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-Request-ID: Root=1-6532dcae-169bf139354cd48959f55c55\n```\n\nIf you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n# Rate Limiting\n\nOur API employs a number of safeguards against bursts of incoming traffic to help maximize its stability.\nThe returned HTTP headers of any API request show your current rate limit status:\n\n```curl\ncurl -i https://api.syntage.com\nHTTP/1.1 200 OK\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 56\nX-RateLimit-Reset: 1606678044\n```\n\n| Header Name | Description |\n|-----------------------|------------------------------------------------------------------------------|\n| X-RateLimit-Limit | The maximum number of requests you're permitted to make. |\n| X-RateLimit-Remaining | The number of requests remaining in the current rate limit window. |\n| X-RateLimit-Reset | The time at which the current rate limit window resets in UTC epoch seconds. |\n\nIf you exceed the rate limit, a [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) response is returned:\n\n```http\nHTTP/1.1 429 Too Many Requests\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 0\nX-RateLimit-Reset: 1606678044\n```\n\nWe may reduce limits to prevent abuse, or increase limits to enable high-traffic operations.\nYou can check your current limits in the [dashboard](https://app.syntage.com/settings/usage).\nTo request an increased rate limit, please [contact support](https://support.syntage.com/).\n# Pagination\nWhen issuing a GET request on a collection containing more than 1 page (e.g. [/events](#operation/ListEvent)), a collection is returned. Links to the first, the last, previous and the next page in the collection are displayed as well as the number of total items in the collection.\nAll endpoints that support this operation have a query parameter defined by:\n - `itemsPerPage` The number of items per page (default: 20, max: 1000)\n - `page` The collection page number\n\n```bash\n \"hydra:totalItems\": 1,\n \"hydra:view\": {\n \"@id\": \"/events?page=1\",\n \"@type\": \"hydra:PartialCollectionView\",\n \"hydra:first\": \"/events?page=1\",\n \"hydra:next\": \"/events?page=2\",\n \"hydra:last\": \"/events?page=3\"\n },\n```\n## Cursor Pagination\nCursor pagination is a technique used for navigating through large datasets efficiently. It allows you to retrieve a specific subset of results from a collection by using a cursor value that represents the position within the collection. The cursor serves as a reference point for fetching the next or previous set of results.\n### Benefits of Cursor Pagination:\n1. **Efficient Navigation:** Cursor pagination eliminates the need to fetch the entire dataset at once, making it more scalable and faster. You can retrieve data in smaller, manageable chunks based on the cursor values.\n2. **Consistent Results:** Each page of results in cursor pagination is stable and doesn't change even if new items are added or removed from the collection. This ensures that you get consistent and reliable results.\n3. **Flexibility:** Cursors can be used to navigate forwards and backwards in the collection without impacting performance.\n\n### How to Use Cursor Pagination:\nTo use cursor pagination with our API, follow these instructions:\n1. Make a request to retrieve the initial page of results. The response will be a JSON-LD document that includes a `hydra:next` attribute with the URI for the next page. The URI already includes the cursor attribute.\n2. To retrieve the next page of results, make a GET request to the URI provided in the `hydra:next` attribute. This URI will automatically include the cursor value for the next page.\n3. If you want to navigate to the previous page, you can use the `hydra:previous` attribute in the JSON-LD response. It will contain the URI for the previous page, including the cursor value.\n4. You can continue making requests to the `hydra:next` and `hydra:previous` URIs to navigate through the paginated results, based on your requirements.\nMake sure to update your request headers to include the necessary headers for JSON-LD content negotiation, such as `Accept: application/ld+json` or `Content-Type: application/ld+json`.\nBy following these instructions, you can effectively navigate through the paginated results using the cursor values provided in the `hydra:next` and `hydra:previous` attributes, without the need to manually include the cursor in your requests. This simplifies the pagination process and enhances the usability of our API.\n\n### Considerations About Cursor Pagination:\n\n - By default, the API uses offset-based pagination (except for a few endpoints that we will list below). If you want to switch to cursor pagination, you need to include an additional header in your request. Set the `X-Pagination-Style` header with the value `\"cursor\"` to enable cursor pagination. If not specified, the API will assume offset-based pagination.\n\n - After enabling cursor pagination, the API response will no longer include the `hydra:totalItems` field by default. Retrieving the total count can be resource intensive and impact response times, especially for large datasets. However, if you need the `hydra:totalItems` information, you can include an additional header in your request. Set the `X-Pagination-Enable-Partial` header with the value `0` to indicate that the response should include extra information, including the `hydra:totalItems` count. Please be aware that enabling this feature may impact API response times, as the backend needs to perform a count operation on the dataset.\n\nIf you require the `hydra:totalItems` count, please consider the potential impact on API response times.\n### Example\n```bash\n curl -i 'https://api.syntage.com/entities/{entityId}/invoices?itemsPerPage=10' \\\n --header 'Accept: application/ld+json' \\\n --header 'X-Api-Key: {apiKey}' \\\n --header 'X-Pagination-Style: cursor' \\\n --header 'X-Pagination-Enable-Partial: 0'\n```\n**Note:** We only support cursor pagination for the following endpoints:\n - `GET /entities/{entityId}/invoices`\n - `GET /entities/{entityId}/invoices/line-items`\n - `GET /entities/{entityId}/invoices/{invoiceId}/line-items`\n - `GET /invoices/{invoiceId}/line-items`\n - `GET /entities/{entityId}/invoices/payments`\n\nFeel free to reach out if you have any further questions or need additional assistance!\n\n# Property Filtering\nThe property filter adds the possibility to select the properties for GET operations.\nSyntax: `?properties[]=<property>&properties[<relation>][]=<property>`\nYou can add as many properties as you need. The following example shows how to select `paymentType` and `issuer.rfc` when fetching a list of invoices.\n```curl\n curl -i https://api.syntage.com/entities/{entityId}/invoices?properties[]=paymentType&properties[issuer]=rfc\n```\n# Filtering\n**Warning:** Collection endpoints only apply the filter query parameters documented for that endpoint. If you send an unsupported or misspelled filter query parameter, the API ignores it and processes the request as if that parameter was not sent.\n\n# API Versioning Guide\nGuidance on changes between versions.\n## Version: 2020-01-01 to 2020-06-28\n### **Invoice**\n_**Affected Endpoints:** `GET /invoices/{id}` and `GET /entities/{entityId}/invoices`_\n- The `amount` property has been removed from API responses. Use the `total` property instead.\n- Retrieval by invoice's `uuid` at `/invoices/{id}` is now removed. To retrieve an invoice, use the invoice's `id` at the specified endpoint. To find an invoice using its `uuid`, filter the invoice collection at `/entities/{entityId}/invoices?uuid[]={uuid}`.\n- Previously, the `@iri` property for an invoice pointed to the resource using `uuid`, like `/invoices/{uuid}`. Now, it points using its `id`, like `/invoices/{id}`.\n\n### **Entity (Formerly Link)**\n_**Affected Endpoint:** `GET /entities`_\n- Filtering entities by `status` is removed. Use `credential.status` instead. For example, utilize `GET /entities?credential.status[]=active` instead of `GET /entities?status[]=active`.\n\n### **Tax Return**\n_**Affected Endpoints:** `GET /tax-returns/{id}` and `GET /entities/{entityId}/tax-returns`_\n- Retrieval by tax return's `operationNumber` at `/tax-returns/{id}` is removed. To retrieve a tax return, use the tax return's `id` at the mentioned endpoint. To find a tax return using its `operationNumber`, filter the collection at `/entities/{entityId}/tax-returns?operationNumber[]={operationNumber}`.\n- Previously, the `@iri` property for a tax return pointed to the resource using `operationNumber`, like `/tax-returns/{operationNumber}`. Now, it directs to its `id`, like `/tax-returns/{id}`.\n\n### **Event**\n_**Affected Endpoints:** `GET /events` and `GET /events/{id}`_\n- For events associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}` instead of the previous `/tax-returns/{operationNumber}`.\n- For events associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}` instead of the previous `/invoices/{uuid}`.\n\n### **Extraction**\n_**Affected Endpoints:** `GET /extractions` and `GET /extractions/{id}`_\n- The `periodFrom` property has been removed. Use `options.period.from` instead.\n- The `periodTo` property has been removed. Use `options.period.to` instead.\n\n### **File**\n_**Affected Endpoint:** `GET /file/{id}`_\n- For files associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}`, instead of the previous `/tax-returns/{operationNumber}`.\n- For files associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}`, instead of the previous `/invoices/{uuid}`.\n\n### Trying Out This Version\nIf you want to test this version, you can do so by making any request with the `Accept-Version` header pointing to the latest version:\n```curl\n curl -i 'https://api.syntage.com/entities/{entityId}/invoices' \\\n --header 'Accept-Version: 2020-06-28' \\\n --header 'X-Api-Key: {apiKey}'\n```\n"
servers:
- url: https://api.syntage.com
description: Production
- url: https://api.sandbox.syntage.com
description: Sandbox
security:
- ApiKey: []
tags:
- name: Reports
description: 'Reports group entity insights into a configurable layout. A report is rendered in the dashboard''s Reports section and can be downloaded as a PDF document with the [Exports API](/api-reference/exports/export-data).
Built-in reports are created and kept up to date by Syntage and cannot be modified or deleted. Custom reports are personal by default; organizational reports are shared with every user in the organization.
'
paths:
/reports:
get:
tags:
- Reports
operationId: ListReports
summary: List all reports
description: 'List the reports available to the authenticated user: built-in reports, the user''s personal reports, and organizational reports.
Insight entries whose feature flags are not enabled for your organization are omitted from the `insights` layout.
'
parameters:
- $ref: '#/components/parameters/createdAtBefore'
- $ref: '#/components/parameters/createdAtStrictlyBefore'
- $ref: '#/components/parameters/createdAtAfter'
- $ref: '#/components/parameters/createdAtStrictlyAfter'
- $ref: '#/components/parameters/orderCreatedAt'
- $ref: '#/components/parameters/collectionPage'
- $ref: '#/components/parameters/collectionLimit'
responses:
'200':
$ref: '#/components/responses/InsightReportCollection'
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- Reports
operationId: CreateReport
summary: Create a report
description: 'Create a custom report with your own selection of insight entries. Set `organizational` to `true` to share the report with every user in your organization instead of keeping it personal.
Reports created through the API are always custom reports: the report-level `builtIn` flag is set only by Syntage and cannot be set through the API.
'
requestBody:
$ref: '#/components/requestBodies/InsightReportSave'
responses:
'201':
$ref: '#/components/responses/InsightReport'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/reports/{id}:
get:
tags:
- Reports
operationId: GetReport
summary: Retrieve a report
description: 'Retrieve a report by ID. Use the report ID as the `uri` path segment when requesting a PDF download with the [Exports API](/api-reference/exports/export-data).
'
parameters:
- $ref: '#/components/parameters/resourceId'
responses:
'200':
$ref: '#/components/responses/InsightReport'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
put:
tags:
- Reports
operationId: UpdateReport
summary: Update a report
description: 'Update a custom report''s name, insight layout, or organizational visibility.
Built-in reports cannot be updated. Personal reports can only be updated by their owner; organizational reports can only be updated by an admin.
'
parameters:
- $ref: '#/components/parameters/resourceId'
requestBody:
$ref: '#/components/requestBodies/InsightReportSave'
responses:
'200':
$ref: '#/components/responses/InsightReport'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
delete:
tags:
- Reports
operationId: DeleteReport
summary: Delete a report
description: 'Delete a custom report.
Built-in reports cannot be deleted. Personal reports can only be deleted by their owner; organizational reports can only be deleted by an admin.
'
parameters:
- $ref: '#/components/parameters/resourceId'
responses:
'204':
description: Report resource deleted
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
CollectionPage:
type: integer
default: 1
InsightReportInsightEntry:
type: object
required:
- name
- type
properties:
name:
type: string
description: Entry identifier within the report layout
example: sales-revenue
type:
type: string
description: '`insight` renders a single insight; `group` renders a titled section of child insight entries'
enum:
- insight
- group
insight:
type: string
description: Name of the insight rendered by this entry; present when `type` is `insight`
example: sales-revenue
visible:
type: boolean
description: Whether the entry is currently shown when the report is rendered
children:
type: array
description: Child insight entries; present when `type` is `group`
items:
$ref: '#/components/schemas/InsightReportInsightEntry'
builtIn:
type: boolean
description: Whether the entry comes from a built-in report definition; omitted for entries defined in custom reports
Collection:
allOf:
- $ref: '#/components/schemas/HydraView'
- type: object
properties:
hydra:search:
type: object
properties:
'@type':
type: string
hydra:template:
type: string
hydra:variableRepresentation:
type: string
hydra:mapping:
type: array
items:
type: object
properties:
'@type':
type: string
variable:
type: string
property:
type: string
required:
type: boolean
updatedAt:
type: string
description: Date and time the resource was last updated
example: '2020-01-01T12:15:00.000Z'
CollectionLimit:
type: integer
default: 20
minimum: 1
maximum: 1000
createdAt:
type: string
description: Date and time the resource was created
example: '2020-01-01T12:15:00.000Z'
InsightReportCollection:
allOf:
- $ref: '#/components/schemas/Collection'
- type: object
properties:
'@context':
default: /contexts/InsightReport
'@id':
default: /reports
hydra:member:
items:
$ref: '#/components/schemas/InsightReport'
InsightReport:
type: object
properties:
'@id':
type: string
format: iri-reference
description: Report IRI reference
example: /reports/91106968-1abd-4d64-85c1-4e73d96fb997
'@type':
type: string
description: JSON-LD resource type
default: InsightReport
id:
type: string
format: uuid
description: Unique report ID
example: 91106968-1abd-4d64-85c1-4e73d96fb997
name:
type: string
description: Report name shown in the dashboard's report selector; built-in reports use stable names such as `full_report`
example: Credit review
builtIn:
type: boolean
description: Whether the report is managed by Syntage; built-in reports are kept up to date automatically and cannot be modified or deleted
example: false
organizational:
type: boolean
description: Whether the report is shared with every user in the organization; personal reports are only visible to their owner
example: false
insights:
type: array
description: Ordered layout of insight entries and groups rendered by the report
items:
$ref: '#/components/schemas/InsightReportInsightEntry'
createdBy:
type: object
description: Profile of the user who created the report; omitted for built-in reports
properties:
id:
type: string
format: uuid
description: User ID
example: 91106968-1abd-4d64-85c1-4e73d96fb997
firstName:
type: string
example: John
lastName:
type: string
example: Doe
fullName:
type: string
example: John Doe
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
CollectionOrder:
type: string
enum:
- asc
- desc
example: asc
HydraView:
type: object
properties:
'@context':
type: string
'@id':
type: string
'@type':
type: string
default: hydra:Collection
hydra:member:
type: array
items:
type: object
hydra:totalItems:
type: integer
description: Total number of items found
minimum: 0
example: 1
hydra:view:
type: object
description: Pagination information
properties:
'@id':
type: string
format: iri-reference
description: Current page IRI reference
'@type':
type: string
default: hydra:PartialCollectionView
hydra:first:
type: string
format: iri-reference
description: First page IRI reference; omitted when there is no pagination
hydra:next:
type: string
format: iri-reference
description: Next page IRI reference; omitted when there is no pagination
hydra:last:
type: string
format: iri-reference
description: Last page IRI reference; omitted when there is no pagination
InsightReportInsightEntryInput:
type: object
required:
- name
- type
properties:
name:
type: string
description: Entry identifier within the report layout
example: sales-revenue
type:
type: string
description: '`insight` renders a single insight; `group` renders a titled section of child insight entries'
enum:
- insight
- group
insight:
type: string
description: Name of the insight rendered by this entry; required when `type` is `insight`
example: sales-revenue
visible:
type: boolean
description: Whether the entry is shown when the report is rendered
children:
type: array
description: Child insight entries; used when `type` is `group`
items:
$ref: '#/components/schemas/InsightReportInsightEntryInput'
parameters:
createdAtStrictlyAfter:
name: createdAt[strictly_after]
in: query
description: Filter by resource creation date (greater than `>`)
example: '2020-01-17 11:47:27'
schema:
type: string
format: date-time
createdAtStrictlyBefore:
name: createdAt[strictly_before]
in: query
description: Filter by resource creation date (less than `<`)
example: '2020-01-17 11:47:27'
schema:
type: string
format: date-time
createdAtBefore:
name: createdAt[before]
in: query
description: Filter by resource creation date (less than or equal `<=`)
example: '2020-01-17 11:47:27'
schema:
type: string
format: date-time
collectionPage:
name: page
in: query
required: false
description: Collection page number
schema:
$ref: '#/components/schemas/CollectionPage'
collectionLimit:
name: itemsPerPage
in: query
required: false
description: Number of items per page
schema:
$ref: '#/components/schemas/CollectionLimit'
orderCreatedAt:
name: order[createdAt]
in: query
description: Order by resource creation date
schema:
$ref: '#/components/schemas/CollectionOrder'
resourceId:
name: id
in: path
required: true
example: 91106968-1abd-4d64-85c1-4e73d96fb997
schema:
type: string
format: uuid
createdAtAfter:
name: createdAt[after]
in: query
description: Filter by resource creation date (greater than or equal `>=`)
example: '2020-01-17 11:47:27'
schema:
type: string
format: date-time
responses:
NotFound:
description: Not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
InsightReport:
description: Report resource response
content:
application/ld+json:
schema:
allOf:
- type: object
properties:
'@context':
type: string
default: /contexts/InsightReport
- $ref: '#/components/schemas/InsightReport'
Forbidden:
description: Forbidden
content:
application/ld+json:
schema:
type: object
properties:
'@context':
type: string
default: /contexts/Error
'@type':
type: string
default: hydra:Error
hydra:title:
type: string
default: An error occurred
hydra:description:
type: string
example: Access Denied.
InsightReportCollection:
description: Report collection response
content:
application/ld+json:
schema:
$ref: '#/components/schemas/InsightReportCollection'
UnprocessableEntity:
description: Unprocessable Entity
content:
application/ld+json:
schema:
type: object
properties:
'@context':
type: string
default: /contexts/Error
'@type':
type: string
default: hydra:Error
hydra:title:
type: string
default: An error occurred
hydra:description:
type: string
description: Concatenated violation messages
example: 'exampleField: Syntage score already exists.'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
message:
type: string
requestBodies:
InsightReportSave:
required: true
content:
application/json:
schema:
type: object
required:
- name
- insights
properties:
name:
type: string
description: Report name shown in the dashboard's report selector
example: Credit review
insights:
type: array
description: Ordered layout of insight entries and groups rendered by the report
items:
$ref: '#/components/schemas/InsightReportInsightEntryInput'
organizational:
type: boolean
description: Share the report with every user in the organization instead of keeping it personal
default: false
securitySchemes:
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.
'
x-readme:
explorer-enabled: true
proxy-enabled: true
samples-enabled: true