List all taxpayer's invoices

GET

taxpayers

{id}

invoices

curl --request GET \
  --url https://api.syntage.com/taxpayers/{id}/invoices \
  --header 'X-API-Key: <api-key>'

{
  "@context": "<string>",
  "@id": "/taxpayers/PEIC211118IS0/invoices",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "Invoice",
      "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
      "uuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
      "version": 3.3,
      "reference": "Branch-A",
      "internalIdentifier": "00001",
      "type": "I",
      "usage": "G03",
      "paymentType": "PUE",
      "paymentMethod": "04",
      "paymentTerms": "immediate_payment",
      "placeOfIssue": "01210",
      "issuer": {
        "rfc": "AOM920820BEA",
        "name": "APPLE OPERATIONS MEXICO S.A. DE C.V.",
        "taxRegime": 601,
        "blacklistStatus": null
      },
      "isIssuer": true,
      "receiver": {
        "rfc": "PEIC211118IS0",
        "name": "Pedro Infante Cruz",
        "blacklistStatus": "presumed"
      },
      "isReceiver": false,
      "currency": "MXN",
      "discount": 3324,
      "tax": 5224,
      "subtotal": 51349.8,
      "creditedAmount": 31.32,
      "subtotalCreditedAmount": 27,
      "total": 53249.8,
      "exchangeRate": 19.8,
      "paidAmount": 53249.8,
      "dueAmount": 0,
      "lastPaymentDate": "2023-11-07T05:31:56Z",
      "fullyPaidAt": "2023-11-07T05:31:56Z",
      "paymentTermsRaw": "Tarjeta de crédito",
      "status": "VIGENTE",
      "pac": "SAT970701NN3",
      "issuedAt": "2019-01-03T21:10:40.000Z",
      "certifiedAt": "2019-01-03T21:10:41.000Z",
      "cancellationStatus": "Cancelable con aceptación",
      "cancellationProcessStatus": "En proceso",
      "canceledAt": "2023-11-07T05:31:56Z",
      "relations": [
        {
          "@id": "/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1",
          "@type": "InvoiceRelation",
          "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
          "type": 7,
          "invoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
          "relatedInvoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
          "relatedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ],
      "xml": true,
      "pdf": true,
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z",
      "tags": [
        {
          "@id": "/tags/91106968-1abd-4d64-85c1-4e73d96fb997",
          "@type": "Tag",
          "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
          "name": "To be reviewed",
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ]
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

string

required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

Query Parameters

uuid

string

Filter by UUID/Folio Fiscal (exact match)

Example:

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

version

number | null

Filter by CFDI version (exact match)

Example:

3.3

type

enum<string>

Filter by type (exact match)

Available options:

I,

E,

P,

N,

T

usage

string | null

Filter by usage (exact match)

Example:

"G03"

paymentType

enum<string> | null

Filter by payment type (exact match)

Available options:

PUE,

PPD

Example:

"PUE"

paymentMethod

string | null

Filter by payment method (exact match)

Example:

"04"

issuer.rfc

string

Filter by issuer RFC (partial match)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

issuer.name

string

Filter by issuer name (partial match)

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

issuer.taxRegime

number | null

Filter by issuer tax regime (partial match)

Example:

601

issuer.blacklistStatus

enum<string> | null

Filter by issuer blacklist status

Available options:

presumed,

dismissed,

definitive,

favorable

Example:

"presumed"

isIssuer

boolean

Filter if the invoice issuer is the taxpayer from the Entity

Example:

true

receiver.rfc

string

Filter by receiver RFC (partial match)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

receiver.name

string

Filter by receiver name (partial match)

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

receiver.blacklistStatus

enum<string> | null

Filter by receiver blacklist status

Available options:

presumed,

dismissed,

definitive,

favorable

Example:

"presumed"

isReceiver

boolean

Filter if the invoice receiver is the taxpayer from the Entity

Example:

false

currency

string | null

Filter by currency code (exact match)

Required string length: 3

Example:

"MXN"

status

enum<string>

Filter by status (exact match)

Available options:

VIGENTE,

CANCELADO

Example:

"VIGENTE"

pac

string

Filter by certification provider (partial match)

Required string length: 12

Example:

"SAT970701NN3"

cancellationStatus

enum<string>

Filter by cancellation status (partial match)

Available options:

Cancelable sin aceptación,

Cancelable con aceptación,

No cancelable

Example:

"Cancelable con aceptación"

cancellationStatusProcess

enum<string> | null

Filter by cancellation process status (partial match)

Available options:

En proceso,

Solicitud rechazada,

Cancelado sin aceptación,

Cancelado con aceptación,

Plazo vencido

Example:

"En proceso"

issuedAt[before]

string

Filter by issue date (less than or equal <=)

Example:

"2019-01-03T21:10:40.000Z"

issuedAt[strictly_before]

string

Filter by issue date (less than <)

Example:

"2019-01-03T21:10:40.000Z"

issuedAt[after]

string

Filter by issue date (greater than or equal >=)

Example:

"2019-01-03T21:10:40.000Z"

issuedAt[strictly_after]

string

Filter by issue date (greater than >)

Example:

"2019-01-03T21:10:40.000Z"

canceledAt[before]

string | null

Filter by cancellation date (less than or equal <=)

canceledAt[strictly_before]

string | null

Filter by cancellation date (less than <)

canceledAt[after]

string | null

Filter by cancellation date (greater than or equal >=)

canceledAt[strictly_after]

string | null

Filter by cancellation date (greater than >)

createdAt[before]

string

Filter by creation date (less than or equal <=)

Example:

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

createdAt[strictly_before]

string

Filter by creation date (less than <)

Example:

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

createdAt[after]

string

Filter by creation date (greater than or equal >=)

Example:

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

createdAt[strictly_after]

string

Filter by creation date (greater than >)

Example:

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

updatedAt[before]

string

Filter by update date (less than or equal <=)

Example:

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

updatedAt[strictly_before]

string

Filter by update date (less than <)

Example:

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

updatedAt[after]

string

Filter by update date (greater than or equal >=)

Example:

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

updatedAt[strictly_after]

string

Filter by update date (greater than >)

Example:

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

certifiedAt[before]

string

Filter by certified date (less than or equal <=)

Example:

"2019-01-03T21:10:41.000Z"

certifiedAt[strictly_before]

string

Filter by certified date (less than <)

Example:

"2019-01-03T21:10:41.000Z"

certifiedAt[after]

string

Filter by certified date (greater than or equal >=)

Example:

"2019-01-03T21:10:41.000Z"

certifiedAt[strictly_after]

string

Filter by certified date (greater than >)

Example:

"2019-01-03T21:10:41.000Z"

lastPaymentDate[before]

string | null

Filter by last payment date (less than or equal <=)

lastPaymentDate[strictly_before]

string | null

Filter by last payment date (less than <)

lastPaymentDate[after]

string | null

Filter by last payment date (greater than or equal >=)

lastPaymentDate[strictly_after]

string | null

Filter by last payment date (greater than >)

fullyPaidAt[before]

string | null

Filter by fully paid date (less than or equal <=)

fullyPaidAt[strictly_before]

string | null

Filter by fully paid date (less than <)

fullyPaidAt[after]

string | null

Filter by fully paid date (greater than or equal >=)

fullyPaidAt[strictly_after]

string | null

Filter by fully paid date (greater than >)

tax[between]

string

Filter by tax between two values

tax[gt]

number

Filter by tax (greater than >)

tax[gte]

number

Filter by tax (greater than or equal >=)

tax[lt]

number

Filter by tax (less than <)

tax[lte]

number

Filter by tax (less than or equal <=)

discount[between]

string

Filter by discount between two values

discount[gt]

number

Filter by discount (greater than >)

discount[gte]

number

Filter by discount (greater than or equal >=)

discount[lt]

number

Filter by discount (less than <)

discount[lte]

number

Filter by discount (less than or equal <=)

subtotal[between]

string

Filter by subtotal between two values

subtotal[gt]

number

Filter by subtotal (greater than >)

subtotal[gte]

number

Filter by subtotal (greater than or equal >=)

subtotal[lt]

number

Filter by subtotal (less than <)

subtotal[lte]

number

Filter by subtotal (less than or equal <=)

total[between]

string

Filter by total between two values

total[gt]

number

Filter by total (greater than >)

total[gte]

number

Filter by total (greater than or equal >=)

total[lt]

number

Filter by total (less than <)

total[lte]

number

Filter by total (less than or equal <=)

paidAmount[between]

string

Filter by paidAmount between two values

paidAmount[gt]

number

Filter by paidAmount (greater than >)

paidAmount[gte]

number

Filter by paidAmount (greater than or equal >=)

paidAmount[lt]

number

Filter by paidAmount (less than <)

paidAmount[lte]

number

Filter by paidAmount (less than or equal <=)

dueAmount[between]

string

Filter by dueAmount between two values

dueAmount[gt]

number

Filter by dueAmount (greater than >)

dueAmount[gte]

number

Filter by dueAmount (greater than or equal >=)

dueAmount[lt]

number

Filter by dueAmount (less than <)

dueAmount[lte]

number

Filter by dueAmount (less than or equal <=)

hasXml

boolean

Filter by invoices that have the CFDI available in XML format

hasPdf

boolean

Filter by invoices that have the CFDI available in PDF format

order[issuedAt]

enum<string>

Order by issue date

Available options:

asc,

desc

Example:

"asc"

order[canceledAt]

enum<string>

Order by cancellation date

Available options:

asc,

desc

Example:

"asc"

order[certifiedAt]

enum<string>

Order by certification date

Available options:

asc,

desc

Example:

"asc"

order[amount]

enum<string>

Order by amount

Available options:

asc,

desc

Example:

"asc"

exists[paymentMethod]

boolean

Filter invoices that contains or not paymentMethod

Example:

true

id[lt]

string

The collection cursor pointer to the next page

id[gt]

string

The collection cursor pointer to the previous page

itemsPerPage

integer

default:20

The number of items per page

Required range: 1 <= x <= 1000

Response

200

application/ld+json

Taxpayer invoice collection response

The response is of type object.

Retrieve an invoice's CFDI Retrieve an invoice line item

curl --request GET \
  --url https://api.syntage.com/taxpayers/{id}/invoices \
  --header 'X-API-Key: <api-key>'

{
  "@context": "<string>",
  "@id": "/taxpayers/PEIC211118IS0/invoices",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "Invoice",
      "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
      "uuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
      "version": 3.3,
      "reference": "Branch-A",
      "internalIdentifier": "00001",
      "type": "I",
      "usage": "G03",
      "paymentType": "PUE",
      "paymentMethod": "04",
      "paymentTerms": "immediate_payment",
      "placeOfIssue": "01210",
      "issuer": {
        "rfc": "AOM920820BEA",
        "name": "APPLE OPERATIONS MEXICO S.A. DE C.V.",
        "taxRegime": 601,
        "blacklistStatus": null
      },
      "isIssuer": true,
      "receiver": {
        "rfc": "PEIC211118IS0",
        "name": "Pedro Infante Cruz",
        "blacklistStatus": "presumed"
      },
      "isReceiver": false,
      "currency": "MXN",
      "discount": 3324,
      "tax": 5224,
      "subtotal": 51349.8,
      "creditedAmount": 31.32,
      "subtotalCreditedAmount": 27,
      "total": 53249.8,
      "exchangeRate": 19.8,
      "paidAmount": 53249.8,
      "dueAmount": 0,
      "lastPaymentDate": "2023-11-07T05:31:56Z",
      "fullyPaidAt": "2023-11-07T05:31:56Z",
      "paymentTermsRaw": "Tarjeta de crédito",
      "status": "VIGENTE",
      "pac": "SAT970701NN3",
      "issuedAt": "2019-01-03T21:10:40.000Z",
      "certifiedAt": "2019-01-03T21:10:41.000Z",
      "cancellationStatus": "Cancelable con aceptación",
      "cancellationProcessStatus": "En proceso",
      "canceledAt": "2023-11-07T05:31:56Z",
      "relations": [
        {
          "@id": "/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1",
          "@type": "InvoiceRelation",
          "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
          "type": 7,
          "invoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
          "relatedInvoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
          "relatedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ],
      "xml": true,
      "pdf": true,
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z",
      "tags": [
        {
          "@id": "/tags/91106968-1abd-4d64-85c1-4e73d96fb997",
          "@type": "Tag",
          "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
          "name": "To be reviewed",
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ]
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

List all taxpayer's invoices

Authorizations

Path Parameters

Query Parameters

Response