openapi: 3.0.2
info:
version: '2020-06-28'
title: Syntage Accounts Payable Insight DS MX SAT Invoices 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: DS MX SAT Invoices
description: 'Invoices represent CFDI documents issued or received by an entity. Invoice records include SAT identifiers, issuer and receiver data, monetary totals, payment status, cancellation status, invoice relationships, file availability, and tags.
Use the entity invoice list when you need all invoices extracted for one entity. Retrieve an invoice by ID when you need the full invoice resource, including tags and related invoice metadata. Use the CFDI endpoint when you need the XML or PDF content for a specific invoice.
### Blacklist status
The field `issuer.blacklistStatus` or `receiver.blacklistStatus` is set when the invoice issuer or receiver
RFC is found in the [SAT 69-B list](https://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html):
| Status | Description |
|-------------|-----------------------------------------------------------------------------------------------------------|
| presumed | SAT has identified possible irregularities and started an investigation |
| dismissed | SAT dismissed the investigation after reviewing evidence |
| definitive | SAT determined that the RFC has confirmed irregularities |
| favorable | SAT reversed a definitive status after reviewing additional evidence |
'
paths:
/invoices/{id}:
get:
tags:
- DS MX SAT Invoices
operationId: GetInvoice
summary: Retrieve an invoice
description: 'Retrieve an invoice by ID, including SAT identifiers, issuer and receiver details, totals, payment status, file availability, and invoice relationships.
'
parameters:
- $ref: '#/components/parameters/invoiceId'
responses:
'200':
$ref: '#/components/responses/InvoiceCollectionItem'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/invoices/{id}/tags:
post:
tags:
- DS MX SAT Invoices
operationId: TagInvoice
summary: Tag an invoice
description: 'Add a tag to an invoice.
'
parameters:
- $ref: '#/components/parameters/resourceId'
requestBody:
$ref: '#/components/requestBodies/TagInvoice'
responses:
'200':
$ref: '#/components/responses/Invoice'
'401':
$ref: '#/components/responses/Unauthorized'
/invoices/{invoiceId}/tags/{tagId}:
delete:
tags:
- DS MX SAT Invoices
operationId: UntagInvoice
summary: Untag an invoice
description: 'Remove a tag from an invoice.
'
parameters:
- name: invoiceId
in: path
required: true
example: 91106968-1abd-4d64-85c1-4e73d96fb997
schema:
type: string
format: uuid
- name: tagId
in: path
required: true
example: 018d9dd9-459f-768e-bc55-a8a72d0d3e9a
schema:
type: string
format: uuid
responses:
'204':
description: Untagged invoice
'401':
$ref: '#/components/responses/Unauthorized'
/invoices/batch/tags:
post:
tags:
- DS MX SAT Invoices
operationId: TagInvoicesBatch
summary: Tag multiple invoices
description: 'Add one or more tags to up to 100 invoices in a single request.
The operation is atomic: if any invoice or tag in the request cannot be found, no invoice is modified. Tags the invoice already has are kept as-is, so retrying the same request is safe.
'
requestBody:
$ref: '#/components/requestBodies/TagInvoicesBatch'
responses:
'201':
$ref: '#/components/responses/TagInvoicesBatch'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: An invoice or tag in the request was not found
'422':
description: Validation error, e.g. empty lists or more than 100 invoices / 50 tags
/invoices/batch/tags/remove:
post:
tags:
- DS MX SAT Invoices
operationId: UntagInvoicesBatch
summary: Untag multiple invoices
description: 'Remove one or more tags from up to 100 invoices in a single request.
The operation is atomic: if any invoice or tag in the request cannot be found, no invoice is modified. Tags an invoice does not have are ignored, so retrying the same request is safe.
'
requestBody:
$ref: '#/components/requestBodies/TagInvoicesBatch'
responses:
'201':
$ref: '#/components/responses/TagInvoicesBatch'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: An invoice or tag in the request was not found
'422':
description: Validation error, e.g. empty lists or more than 100 invoices / 50 tags
/invoices/{id}/cfdi:
get:
tags:
- DS MX SAT Invoices
operationId: GetInvoiceCFDI
summary: Retrieve an invoice's CFDI
description: 'Retrieve the invoice CFDI in the requested format.
By default, this endpoint returns the CFDI parsed from XML to JSON. Set `Accept: text/xml` to retrieve the original XML file, or `Accept: application/pdf` to retrieve the PDF representation when one is available.
'
parameters:
- $ref: '#/components/parameters/invoiceId'
- name: Accept
in: header
schema:
type: string
description: 'This header controls the output format:
- **text/xml:** Original XML file
- **application/pdf:** Original PDF file (XML''s visual representation)
- **application/json:** Original XML file converted to JSON
'
enum:
- text/xml
- application/pdf
- application/json
default: application/json
responses:
'200':
$ref: '#/components/responses/InvoiceCFDI'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/datasources/mx/sat/cfdis/{uuid}:
get:
tags:
- DS MX SAT Invoices
operationId: GetMxSatCfdi
summary: Retrieve a SAT CFDI
description: 'Retrieve parsed SAT CFDI data by invoice UUID.
When `X-Async-Process` is set to `1`, the endpoint can return `202 Accepted` while CFDI parsing continues asynchronously.
'
parameters:
- name: uuid
in: path
required: true
description: Invoice UUID
schema:
type: string
format: uuid
example: def404af-5eef-4112-aa99-d1ec8493b89a
- name: X-Async-Process
in: header
required: false
description: Set to `1` to request asynchronous processing when the CFDI has not been parsed yet
schema:
type: string
enum:
- '0'
- '1'
default: '0'
responses:
'200':
description: Parsed SAT CFDI response
content:
application/ld+json:
schema:
$ref: '#/components/schemas/MxSatCfdi'
'202':
description: CFDI parsing accepted
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Processing status message
example: The CFDI is being processed and will be available soon. Please try again later.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/entities/{entityId}/invoices:
get:
tags:
- DS MX SAT Invoices
operationId: ListTaxpayerInvoice
summary: List an entity's invoices
description: 'List invoices extracted for an entity.
'
parameters:
- $ref: '#/components/parameters/entityId'
- name: uuid
in: query
description: Filter by UUID/Folio Fiscal (exact match)
schema:
$ref: '#/components/schemas/InvoiceID'
- name: version
in: query
description: Filter by CFDI version (exact match)
example: 3.2
schema:
$ref: '#/components/schemas/InvoiceVersion'
- name: type
in: query
description: Filter by type (exact match)
example: I
schema:
$ref: '#/components/schemas/InvoiceType'
- name: usage
in: query
description: Filter by usage (exact match)
example: G03
schema:
$ref: '#/components/schemas/InvoiceUsage'
- name: paymentType
in: query
description: Filter by payment type (exact match)
schema:
$ref: '#/components/schemas/InvoicePaymentType'
- name: paymentMethod
in: query
description: Filter by payment method (exact match)
schema:
$ref: '#/components/schemas/InvoicePaymentMethod'
- name: issuer.rfc
in: query
example: AOM920820BEA
description: Filter by issuer RFC (partial match)
schema:
$ref: '#/components/schemas/TaxpayerID'
- name: issuer.name
in: query
description: Filter by issuer name (partial match)
example: Apple
schema:
$ref: '#/components/schemas/TaxpayerName'
- name: issuer.taxRegime
in: query
description: Filter by issuer tax regime (partial match)
schema:
$ref: '#/components/schemas/InvoiceIssuerTaxRegime'
- name: issuer.blacklistStatus
in: query
description: Filter by issuer blacklist status
example: presumed
schema:
$ref: '#/components/schemas/TaxpayerBlacklistStatus'
- name: isIssuer
in: query
description: Filter by whether the invoice issuer is the entity's RFC
example: true
schema:
$ref: '#/components/schemas/InvoiceIsIssuer'
- name: receiver.rfc
in: query
description: Filter by receiver RFC (partial match)
schema:
$ref: '#/components/schemas/TaxpayerID'
- name: receiver.name
in: query
description: Filter by receiver name (partial match)
example: Pedro
schema:
$ref: '#/components/schemas/TaxpayerName'
- name: receiver.blacklistStatus
in: query
description: Filter by receiver blacklist status
example: definitive
schema:
$ref: '#/components/schemas/TaxpayerBlacklistStatus'
- name: isReceiver
in: query
description: Filter by whether the invoice receiver is the entity's RFC
example: false
schema:
$ref: '#/components/schemas/InvoiceIsReceiver'
- name: currency
in: query
description: Filter by currency code (exact match)
schema:
$ref: '#/components/schemas/InvoiceCurrency'
- name: status
in: query
description: Filter by status (exact match)
schema:
$ref: '#/components/schemas/InvoiceStatus'
- name: pac
in: query
description: Filter by certification provider (partial match)
schema:
$ref: '#/components/schemas/InvoicePac'
- name: cancellationStatus
in: query
description: Filter by cancellation status (partial match)
schema:
$ref: '#/components/schemas/InvoiceCancellationStatus'
- name: cancellationStatusProcess
in: query
description: Filter by cancellation process status (partial match)
schema:
$ref: '#/components/schemas/InvoiceCancellationStatusProcess'
- name: issuedAt[before]
in: query
description: Filter by issue date (less than or equal `<=`)
schema:
$ref: '#/components/schemas/InvoiceIssuedAt'
- name: issuedAt[strictly_before]
in: query
description: Filter by issue date (less than `<`)
schema:
$ref: '#/components/schemas/InvoiceIssuedAt'
- name: issuedAt[after]
in: query
description: Filter by issue date (greater than or equal `>=`)
schema:
$ref: '#/components/schemas/InvoiceIssuedAt'
- name: issuedAt[strictly_after]
in: query
description: Filter by issue date (greater than `>`)
schema:
$ref: '#/components/schemas/InvoiceIssuedAt'
- name: canceledAt[before]
in: query
description: Filter by cancellation date (less than or equal `<=`)
schema:
$ref: '#/components/schemas/InvoiceCanceledAt'
- name: canceledAt[strictly_before]
in: query
description: Filter by cancellation date (less than `<`)
schema:
$ref: '#/components/schemas/InvoiceCanceledAt'
- name: canceledAt[after]
in: query
description: Filter by cancellation date (greater than or equal `>=`)
schema:
$ref: '#/components/schemas/InvoiceCanceledAt'
- name: canceledAt[strictly_after]
in: query
description: Filter by cancellation date (greater than `>`)
schema:
$ref: '#/components/schemas/InvoiceCanceledAt'
- name: createdAt[before]
in: query
description: Filter by creation date (less than or equal `<=`)
schema:
$ref: '#/components/schemas/createdAt'
- name: createdAt[strictly_before]
in: query
description: Filter by creation date (less than `<`)
schema:
$ref: '#/components/schemas/createdAt'
- name: createdAt[after]
in: query
description: Filter by creation date (greater than or equal `>=`)
schema:
$ref: '#/components/schemas/createdAt'
- name: createdAt[strictly_after]
in: query
description: Filter by creation date (greater than `>`)
schema:
$ref: '#/components/schemas/createdAt'
- name: updatedAt[before]
in: query
description: Filter by update date (less than or equal `<=`)
schema:
$ref: '#/components/schemas/updatedAt'
- name: updatedAt[strictly_before]
in: query
description: Filter by update date (less than `<`)
schema:
$ref: '#/components/schemas/updatedAt'
- name: updatedAt[after]
in: query
description: Filter by update date (greater than or equal `>=`)
schema:
$ref: '#/components/schemas/updatedAt'
- name: updatedAt[strictly_after]
in: query
description: Filter by update date (greater than `>`)
schema:
$ref: '#/components/schemas/updatedAt'
- name: certifiedAt[before]
in: query
description: Filter by certified date (less than or equal `<=`)
schema:
$ref: '#/components/schemas/InvoiceCertifiedAt'
- name: certifiedAt[strictly_before]
in: query
description: Filter by certified date (less than `<`)
schema:
$ref: '#/components/schemas/InvoiceCertifiedAt'
- name: certifiedAt[after]
in: query
description: Filter by certified date (greater than or equal `>=`)
schema:
$ref: '#/components/schemas/InvoiceCertifiedAt'
- name: certifiedAt[strictly_after]
in: query
description: Filter by certified date (greater than `>`)
schema:
$ref: '#/components/schemas/InvoiceCertifiedAt'
- name: lastPaymentDate[before]
in: query
description: Filter by last payment date (less than or equal `<=`)
schema:
$ref: '#/components/schemas/InvoiceLastPaymentDate'
- name: lastPaymentDate[strictly_before]
in: query
description: Filter by last payment date (less than `<`)
schema:
$ref: '#/components/schemas/InvoiceLastPaymentDate'
- name: lastPaymentDate[after]
in: query
description: Filter by last payment date (greater than or equal `>=`)
schema:
$ref: '#/components/schemas/InvoiceLastPaymentDate'
- name: lastPaymentDate[strictly_after]
in: query
description: Filter by last payment date (greater than `>`)
schema:
$ref: '#/components/schemas/InvoiceLastPaymentDate'
- name: fullyPaidAt[before]
in: query
description: Filter by fully paid date (less than or equal `<=`)
schema:
$ref: '#/components/schemas/InvoiceFullyPaidAt'
- name: fullyPaidAt[strictly_before]
in: query
description: Filter by fully paid date (less than `<`)
schema:
$ref: '#/components/schemas/InvoiceFullyPaidAt'
- name: fullyPaidAt[after]
in: query
description: Filter by fully paid date (greater than or equal `>=`)
schema:
$ref: '#/components/schemas/InvoiceFullyPaidAt'
- name: fullyPaidAt[strictly_after]
in: query
description: Filter by fully paid date (greater than `>`)
schema:
$ref: '#/components/schemas/InvoiceFullyPaidAt'
- name: tax[between]
in: query
description: Filter by tax between two values
example: 12.99..15.99
schema:
type: string
- name: tax[gt]
in: query
description: Filter by tax (greater than `>`)
example: 12.99
schema:
type: number
- name: tax[gte]
in: query
description: Filter by tax (greater than or equal `>=`)
example: 12.99
schema:
type: number
- name: tax[lt]
in: query
description: Filter by tax (less than `<`)
example: 15.99
schema:
type: number
- name: tax[lte]
in: query
description: Filter by tax (less than or equal `<=`)
example: 15.99
schema:
type: number
- name: discount[between]
in: query
description: Filter by discount between two values
example: 12.99..15.99
schema:
type: string
- name: discount[gt]
in: query
description: Filter by discount (greater than `>`)
example: 12.99
schema:
type: number
- name: discount[gte]
in: query
description: Filter by discount (greater than or equal `>=`)
example: 12.99
schema:
type: number
- name: discount[lt]
in: query
description: Filter by discount (less than `<`)
example: 15.99
schema:
type: number
- name: discount[lte]
in: query
description: Filter by discount (less than or equal `<=`)
example: 15.99
schema:
type: number
- name: subtotal[between]
in: query
description: Filter by subtotal between two values
example: 12.99..15.99
schema:
type: string
- name: subtotal[gt]
in: query
description: Filter by subtotal (greater than `>`)
example: 12.99
schema:
type: number
- name: subtotal[gte]
in: query
description: Filter by subtotal (greater than or equal `>=`)
example: 12.99
schema:
type: number
- name: subtotal[lt]
in: query
description: Filter by subtotal (less than `<`)
example: 15.99
schema:
type: number
- name: subtotal[lte]
in: query
description: Filter by subtotal (less than or equal `<=`)
example: 15.99
schema:
type: number
- name: total[between]
in: query
description: Filter by total between two values
example: 12.99..15.99
schema:
type: string
- name: total[gt]
in: query
description: Filter by total (greater than `>`)
example: 12.99
schema:
type: number
- name: total[gte]
in: query
description: Filter by total (greater than or equal `>=`)
example: 12.99
schema:
type: number
- name: total[lt]
in: query
description: Filter by total (less than `<`)
example: 15.99
schema:
type: number
- name: total[lte]
in: query
description: Filter by total (less than or equal `<=`)
example: 15.99
schema:
type: number
- name: paidAmount[between]
in: query
description: Filter by paidAmount between two values
# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/syntage/refs/heads/main/openapi/syntage-ds-mx-sat-invoices-api-openapi.yml