Batch payments are derived from payment receipt CFDIs, also known as type `P` invoices. A batch payment groups one or more invoice payments into the payment transaction reported by SAT. Use batch payments when you need payment-method, currency, bank, operation-number, or transaction-level information. Use invoice payments when you need the amount applied to a specific deferred invoice.
openapi: 3.0.2
info:
version: '2020-06-28'
title: Syntage Accounts Payable Insight DS MX SAT Invoice Batch Payments 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 Invoice Batch Payments
description: 'Batch payments are derived from payment receipt CFDIs, also known as type `P` invoices. A batch payment groups one or more invoice payments into the payment transaction reported by SAT.
Use batch payments when you need payment-method, currency, bank, operation-number, or transaction-level information. Use invoice payments when you need the amount applied to a specific deferred invoice.
'
paths:
/invoices/batch-payments:
get:
tags:
- DS MX SAT Invoice Batch Payments
summary: List all invoice batch payments
description: 'List batch payments derived from invoice payment receipts.
'
operationId: ListBatchPayment
parameters:
- $ref: '#/components/parameters/collectionCursorNextPageParam'
- $ref: '#/components/parameters/collectionCursorPreviousPageParam'
- $ref: '#/components/parameters/collectionLimit'
responses:
'200':
$ref: '#/components/responses/InvoiceBatchPaymentCollection'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/invoices/batch-payments/{id}:
get:
tags:
- DS MX SAT Invoice Batch Payments
summary: Retrieve an invoice batch payment
operationId: GetInvoiceBatchPayment
description: 'Retrieve an invoice batch payment by ID, including transaction-level payment details and related invoice payments.
'
parameters:
- $ref: '#/components/parameters/resourceId'
responses:
'200':
$ref: '#/components/responses/InvoiceBatchPayment'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/invoices/{id}/batch-payments:
get:
tags:
- DS MX SAT Invoice Batch Payments
summary: List an invoice's batch payments
description: 'List all batch payments related to the requested invoice.
'
operationId: ListInvoiceBatchPayments
parameters:
- $ref: '#/components/parameters/invoiceId'
- $ref: '#/components/parameters/collectionCursorNextPageParam'
- $ref: '#/components/parameters/collectionCursorPreviousPageParam'
- $ref: '#/components/parameters/collectionLimit'
responses:
'200':
$ref: '#/components/responses/InvoiceBatchPaymentCollection'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
InvoicePac:
type: string
minLength: 12
maxLength: 12
description: Certification provider tax ID (Proveedor Autorizado de Certificación)
example: SAT970701NN3
InvoicePaymentCurrency:
type: string
description: ISO 4217 alphabetic currency code
minLength: 3
maxLength: 3
nullable: true
example: MXN
InvoiceIssuerTaxRegime:
type: number
enum:
- 601
- 603
- 605
- 606
- 607
- 608
- 609
- 610
- 611
- 612
- 614
- 615
- 616
- 620
- 621
- 622
- 623
- 624
- 625
- 626
- 628
- 629
- 630
description: Tax regime code from the [c_RegimenFiscal](/guides/catalogs#c_regimenfiscal) catalog
nullable: true
example: 601
externalDocs:
url: https://syntage.com/docs/catalogs#c_regimenfiscal
InvoiceTotal:
type: number
format: float
description: Invoice total amount
example: 53249.8
InvoiceType:
type: string
enum:
- I
- E
- P
- N
- T
description: Invoice type code from the [c_TipoDeComprobante](/guides/catalogs#c_tipodecomprobante) catalog
externalDocs:
url: https://syntage.com/docs/catalogs/#c_tipodecomprobante
InvoiceUUID:
type: string
format: uuid
description: Invoice UUID (Folio fiscal)
example: def404af-5eef-4112-aa99-d1ec8493b89a
InvoiceStatus:
type: string
enum:
- VIGENTE
- CANCELADO
description: Whether the invoice is active or canceled
example: VIGENTE
InvoiceVersion:
type: number
format: float
enum:
- 3.2
- 3.3
- 4.0
description: CFDI version
nullable: true
example: 3.3
InvoiceIsIssuer:
type: boolean
description: '`true` if the invoice issuer is the entity''s RFC
'
example: true
InvoiceBatchPaymentDate:
type: string
format: date-time
description: Payment date
nullable: true
InvoiceUsage:
type: string
enum:
- G01
- G02
- G03
- I01
- I02
- I03
- I04
- I05
- I06
- I07
- I08
- D01
- D02
- D03
- D04
- D05
- D06
- D07
- D08
- D09
- D10
- S01
- P01
- CP01
- CN01
example: G03
description: Invoice usage code from the [c_UsoCFDI](/guides/catalogs#c_usocfdi) catalog
nullable: true
externalDocs:
url: https://syntage.com/docs/catalogs/#c_usocfdi
InvoiceBatchPaymentAmount:
type: number
format: float
description: Total batch payment amount. Positive values are income for the entity; negative values are expenses.
example: -53249.8
InvoiceDueAmount:
type: number
format: float
description: For a deferred invoice this field state the due amount. (Applies only for "PPD" invoices).
example: 0
InvoiceBatchPaymentCurrency:
type: string
description: ISO 4217 alphabetic currency code
minLength: 3
maxLength: 3
nullable: true
example: MXN
CursorCollection:
type: object
properties:
'@context':
type: string
'@id':
type: string
'@type':
type: string
default: hydra:Collection
hydra:member:
type: array
items:
type: object
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:next:
type: string
example: /entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367
description: Next page IRI reference; omitted when there is no pagination
hydra:last:
type: string
example: /entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367
description: Last page IRI reference; omitted when there is no pagination
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
InvoiceBatchPaymentExchangeRate:
type: number
format: float
description: Set when `currency` is different than MXN
nullable: true
example: 19.8
InvoiceCreditedAmount:
type: number
format: float
description: Credited amount
nullable: true
example: 31.32
InvoicePaymentMethod:
type: string
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- 08
- '12'
- '13'
- '14'
- '15'
- '17'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '30'
- '31'
- '99'
example: '04'
description: Payment method code from the [c_FormaPago](/guides/catalogs#c_formapago) catalog
nullable: true
externalDocs:
url: https://syntage.com/docs/catalogs#c_formapago
InvoiceBatchPaymentPaymentMethod:
type: string
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- 08
- '12'
- '13'
- '14'
- '15'
- '17'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '30'
- '31'
- '99'
example: '04'
description: Payment method code from the [c_FormaPago](/guides/catalogs#c_formapago) catalog
nullable: true
externalDocs:
url: https://syntage.com/docs/catalogs#c_formapago
InvoiceSubtotalCreditedAmount:
type: number
format: float
description: Subtotal credited amount
nullable: true
example: 27
InvoiceCollectionItem:
type: object
properties:
'@id':
type: string
format: iri-reference
description: Invoice IRI reference
example: /invoices/91106968-1abd-4d64-85c1-4e73d96fb997
'@type':
type: string
default: Invoice
id:
$ref: '#/components/schemas/InvoiceID'
uuid:
$ref: '#/components/schemas/InvoiceUUID'
version:
$ref: '#/components/schemas/InvoiceVersion'
reference:
$ref: '#/components/schemas/InvoiceReference'
internalIdentifier:
$ref: '#/components/schemas/InvoiceInternalIdentifier'
type:
$ref: '#/components/schemas/InvoiceType'
usage:
$ref: '#/components/schemas/InvoiceUsage'
paymentType:
$ref: '#/components/schemas/InvoicePaymentType'
paymentMethod:
$ref: '#/components/schemas/InvoicePaymentMethod'
paymentTerms:
$ref: '#/components/schemas/InvoicePaymentTerms'
placeOfIssue:
$ref: '#/components/schemas/InvoicePlaceOfIssue'
issuer:
$ref: '#/components/schemas/InvoiceIssuer'
isIssuer:
$ref: '#/components/schemas/InvoiceIsIssuer'
receiver:
$ref: '#/components/schemas/InvoiceReceiver'
isReceiver:
$ref: '#/components/schemas/InvoiceIsReceiver'
currency:
$ref: '#/components/schemas/InvoiceCurrency'
discount:
$ref: '#/components/schemas/InvoiceDiscount'
tax:
$ref: '#/components/schemas/InvoiceTax'
subtotal:
$ref: '#/components/schemas/InvoiceSubtotal'
creditedAmount:
$ref: '#/components/schemas/InvoiceCreditedAmount'
subtotalCreditedAmount:
$ref: '#/components/schemas/InvoiceSubtotalCreditedAmount'
total:
$ref: '#/components/schemas/InvoiceTotal'
exchangeRate:
$ref: '#/components/schemas/InvoiceExchangeRate'
paidAmount:
$ref: '#/components/schemas/InvoicePaidAmount'
dueAmount:
$ref: '#/components/schemas/InvoiceDueAmount'
lastPaymentDate:
$ref: '#/components/schemas/InvoiceLastPaymentDate'
fullyPaidAt:
$ref: '#/components/schemas/InvoiceFullyPaidAt'
paymentTermsRaw:
$ref: '#/components/schemas/InvoicePaymentTermsRaw'
status:
$ref: '#/components/schemas/InvoiceStatus'
pac:
$ref: '#/components/schemas/InvoicePac'
issuedAt:
$ref: '#/components/schemas/InvoiceIssuedAt'
certifiedAt:
$ref: '#/components/schemas/InvoiceCertifiedAt'
cancellationStatus:
$ref: '#/components/schemas/InvoiceCancellationStatus'
cancellationProcessStatus:
$ref: '#/components/schemas/InvoiceCancellationStatusProcess'
canceledAt:
$ref: '#/components/schemas/InvoiceCanceledAt'
relations:
type: array
items:
$ref: '#/components/schemas/InvoiceRelation'
xml:
$ref: '#/components/schemas/InvoiceHasXML'
pdf:
$ref: '#/components/schemas/InvoiceHasPDF'
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
InvoicePaymentOutstandingBalance:
type: number
format: float
description: Due amount after a payment
example: 0
Tag:
type: object
properties:
'@id':
type: string
format: iri-reference
description: Resource tag IRI reference
example: /tags/91106968-1abd-4d64-85c1-4e73d96fb997
'@type':
type: string
description: JSON-LD resource type
default: Tag
id:
$ref: '#/components/schemas/uuid'
name:
type: string
description: Display name for the tag
example: To be reviewed
nullable: false
resourceType:
type: string
description: Resource type this tag can be applied to
example: invoice
color:
type: string
description: Lowercase 7-character hexadecimal color used to display the tag (`#RRGGBB`). Defaults to `#a3aab5` when a tag is created without a color.
example: '#22c558'
nullable: true
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
InvoiceTax:
type: number
format: float
description: Tax amount
example: 5224
TagCollection:
type: array
items:
$ref: '#/components/schemas/Tag'
TaxpayerID:
type: string
minLength: 12
maxLength: 13
description: RFC (Registro Federal de Contribuyentes)
example: PEIC211118IS0
InvoiceBatchPayment:
type: object
properties:
'@id':
type: string
format: iri-reference
description: Invoice Batch Payment IRI reference
example: /invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997
'@type':
type: string
default: InvoiceBatchPayment
id:
$ref: '#/components/schemas/InvoiceBatchPaymentID'
date:
$ref: '#/components/schemas/InvoiceBatchPaymentDate'
paymentMethod:
$ref: '#/components/schemas/InvoiceBatchPaymentPaymentMethod'
currency:
$ref: '#/components/schemas/InvoiceBatchPaymentCurrency'
exchangeRate:
$ref: '#/components/schemas/InvoiceBatchPaymentExchangeRate'
amount:
$ref: '#/components/schemas/InvoiceBatchPaymentAmount'
operationNumber:
$ref: '#/components/schemas/InvoiceBatchPaymentOperationNumber'
beneficiaryBank:
$ref: '#/components/schemas/InvoiceBatchPaymentBeneficiaryBank'
payerBank:
$ref: '#/components/schemas/InvoiceBatchPaymentPayerBank'
payments:
type: array
items:
allOf:
- $ref: '#/components/schemas/InvoicePayment'
invoice:
allOf:
- $ref: '#/components/schemas/Invoice'
canceledAt:
$ref: '#/components/schemas/InvoiceBatchPaymentCanceledAt'
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
InvoiceHasXML:
type: boolean
description: '`true` when the CFDI is available in the XML format. The file can be downloaded through the [retrieve an invoice CFDI](#operation/GetInvoiceCFDI) operation
'
InvoiceCurrency:
type: string
description: ISO 4217 alphabetic currency code
minLength: 3
maxLength: 3
nullable: true
example: MXN
InvoicePayment:
type: object
properties:
'@id':
type: string
format: iri-reference
description: Invoice Payment IRI reference
example: /invoices/payments/91106968-1abd-4d64-85c1-4e73d96fb997
'@type':
type: string
default: InvoicePayment
id:
$ref: '#/components/schemas/InvoicePaymentID'
invoiceUuid:
$ref: '#/components/schemas/InvoicePaymentInvoiceUUID'
currency:
$ref: '#/components/schemas/InvoicePaymentCurrency'
exchangeRate:
$ref: '#/components/schemas/InvoicePaymentExchangeRate'
installment:
$ref: '#/components/schemas/InvoicePaymentInstallment'
previousBalance:
$ref: '#/components/schemas/InvoicePaymentPreviousBalance'
amount:
$ref: '#/components/schemas/InvoicePaymentAmount'
outstandingBalance:
$ref: '#/components/schemas/InvoicePaymentOutstandingBalance'
invoice:
type: string
format: iri-reference
description: Invoice IRI reference
example: /invoices/91106968-1abd-4d64-85c1-4e73d96fb997
batchPayment:
type: string
format: iri-reference
description: Invoice Batch Payment IRI reference
example: /invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997
canceledAt:
$ref: '#/components/schemas/InvoicePaymentCanceledAt'
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
InvoicePaymentPreviousBalance:
type: number
format: float
description: Amount before the payment
example: 53249.8
updatedAt:
type: string
description: Date and time the resource was last updated
example: '2020-01-01T12:15:00.000Z'
InvoiceIssuer:
type: object
properties:
rfc:
$ref: '#/components/schemas/TaxpayerID'
name:
$ref: '#/components/schemas/TaxpayerName'
taxRegime:
$ref: '#/components/schemas/InvoiceIssuerTaxRegime'
blacklistStatus:
$ref: '#/components/schemas/TaxpayerBlacklistStatus'
example:
rfc: AOM920820BEA
name: APPLE OPERATIONS MEXICO S.A. DE C.V.
taxRegime: 601
blacklistStatus: null
TaxpayerBlacklistStatus:
type: string
description: Show the blacklist status if a taxpayer is found in the list 69-B from SAT
nullable: true
example: presumed
enum:
- presumed
- dismissed
- definitive
- favorable
InvoiceExchangeRate:
type: number
format: float
description: Set when *currency* is different than MXN (Mexican Peso).
nullable: true
example: 19.8
createdAt:
type: string
description: Date and time the resource was created
example: '2020-01-01T12:15:00.000Z'
InvoicePaymentID:
type: string
format: uuid
description: Invoice Payment ID
example: 91106968-1abd-4d64-85c1-4e73d96fb997
InvoiceRelationType:
type: number
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
description: Invoice relation type code from the [c_TipoRelacion](/guides/catalogs#c_tiporelacion) catalog
example: 7
externalDocs:
url: https://syntage.com/docs/catalogs/#c_tiporelacion
InvoiceDiscount:
type: number
format: float
description: Discount amount
example: 3324
InvoiceIssuedAt:
type: string
format: date-time
description: Invoice issue date
example: '2019-01-03T21:10:40.000Z'
uuid:
type: string
format: uuid
example: e0a24894-7fbf-48ae-bfb0-efaae30a6319
InvoiceRelationInvoice:
type: string
format: iri-reference
description: Invoice IRI reference
example: /invoices/92106967-2abd-5d64-95c2-4e73d96fb998
InvoiceBatchPaymentCollection:
allOf:
- $ref: '#/components/schemas/CursorCollection'
- type: object
properties:
'@context':
default: /contexts/InvoiceBatchPayment
'@id':
default: /invoices/batch-payments
hydra:member:
items:
$ref: '#/components/schemas/InvoiceBatchPayment'
InvoicePaymentExchangeRate:
type: number
format: float
description: Set when `currency` is different than MXN
nullable: true
example: 19.8
InvoiceLastPayme
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/syntage/refs/heads/main/openapi/syntage-ds-mx-sat-invoice-batch-payments-api-openapi.yml