List an entity's invoices

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

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/entities/{entityId}/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syntage.com/entities/{entityId}/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/entities/{entityId}/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities/{entityId}/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "@context": "/contexts/Invoice",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/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",
          "resourceType": "invoice",
          "color": "#22c558",
          "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
      }
    ]
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

entities

{entityId}

invoices

List an entity's invoices

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

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/entities/{entityId}/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syntage.com/entities/{entityId}/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/entities/{entityId}/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities/{entityId}/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "@context": "/contexts/Invoice",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/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",
          "resourceType": "invoice",
          "color": "#22c558",
          "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
      }
    ]
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

entityId

string<uuid>

required

Query Parameters

uuid

string<uuid>

Filter by UUID/Folio Fiscal (exact match) Invoice ID

Example:

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

version

enum<number> | null

CFDI version

Available options:

3.2,

3.3,

4

Example:

3.3

type

enum<string>

Filter by type (exact match) Invoice type code from the c_TipoDeComprobante catalog

Available options:

I,

E,

P,

N,

T

usage

enum<string> | null

Filter by usage (exact match) Invoice usage code from the c_UsoCFDI catalog

Available options:

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"

paymentType

enum<string> | null

Filter by payment type (exact match) Payment type code from the c_MetodoPago catalog

Available options:

PUE,

PPD

Example:

"PUE"

paymentMethod

enum<string> | null

Filter by payment method (exact match) Payment method code from the c_FormaPago catalog

Available options:

01,

02,

03,

04,

05,

06,

08,

12,

13,

14,

15,

17,

23,

24,

25,

26,

27,

28,

29,

30,

31,

99

Example:

"04"

issuer.rfc

string

Filter by issuer RFC (partial match) RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

issuer.name

string

Filter by issuer name (partial match) Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

issuer.taxRegime

enum<number> | null

Filter by issuer tax regime (partial match) Tax regime code from the c_RegimenFiscal catalog

Available options:

601,

603,

605,

606,

607,

608,

609,

610,

611,

612,

614,

615,

616,

620,

621,

622,

623,

624,

625,

626,

628,

629,

630

Example:

601

issuer.blacklistStatus

enum<string> | null

Filter by issuer blacklist status The blacklist status while a taxpayer appears in a current SAT 69-B publication source

Available options:

presumed,

dismissed,

definitive,

favorable

Example:

"presumed"

isIssuer

boolean

Filter by whether the invoice issuer is the entity's RFC true if the invoice issuer is the entity's RFC

Example:

true

receiver.rfc

string

Filter by receiver RFC (partial match) RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

receiver.name

string

Filter by receiver name (partial match) Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

receiver.blacklistStatus

enum<string> | null

Filter by receiver blacklist status The blacklist status while a taxpayer appears in a current SAT 69-B publication source

Available options:

presumed,

dismissed,

definitive,

favorable

Example:

"presumed"

isReceiver

boolean

Filter by whether the invoice receiver is the entity's RFC true if the invoice receiver is the entity's RFC

Example:

false

currency

string | null

Filter by currency code (exact match) ISO 4217 alphabetic currency code

Required string length: 3

Example:

"MXN"

status

enum<string>

Filter by status (exact match) Whether the invoice is active or canceled

Available options:

VIGENTE,

CANCELADO

Example:

"VIGENTE"

pac

string

Filter by certification provider (partial match) Certification provider tax ID (Proveedor Autorizado de Certificación)

Required string length: 12

Example:

"SAT970701NN3"

cancellationStatus

enum<string>

Filter by cancellation status (partial match) Whether or not the invoice can be canceled

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) Set when the cancellation process starts

Available options:

En proceso,

Solicitud rechazada,

Cancelado sin aceptación,

Cancelado con aceptación,

Plazo vencido

Example:

"En proceso"

issuedAt[before]

string<date-time>

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

Example:

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

issuedAt[strictly_before]

string<date-time>

Filter by issue date (less than <) Invoice issue date

Example:

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

issuedAt[after]

string<date-time>

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

Example:

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

issuedAt[strictly_after]

string<date-time>

Filter by issue date (greater than >) Invoice issue date

Example:

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

canceledAt[before]

string<date-time> | null

Filter by cancellation date (less than or equal <=) Set when status is CANCELADO

canceledAt[strictly_before]

string<date-time> | null

Filter by cancellation date (less than <) Set when status is CANCELADO

canceledAt[after]

string<date-time> | null

Filter by cancellation date (greater than or equal >=) Set when status is CANCELADO

canceledAt[strictly_after]

string<date-time> | null

Filter by cancellation date (greater than >) Set when status is CANCELADO

createdAt[before]

string

Filter by creation date (less than or equal <=) Date and time the resource was created

Example:

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

createdAt[strictly_before]

string

Filter by creation date (less than <) Date and time the resource was created

Example:

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

createdAt[after]

string

Filter by creation date (greater than or equal >=) Date and time the resource was created

Example:

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

createdAt[strictly_after]

string

Filter by creation date (greater than >) Date and time the resource was created

Example:

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

updatedAt[before]

string

Filter by update date (less than or equal <=) Date and time the resource was last updated

Example:

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

updatedAt[strictly_before]

string

Filter by update date (less than <) Date and time the resource was last updated

Example:

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

updatedAt[after]

string

Filter by update date (greater than or equal >=) Date and time the resource was last updated

Example:

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

updatedAt[strictly_after]

string

Filter by update date (greater than >) Date and time the resource was last updated

Example:

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

certifiedAt[before]

string<date-time>

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

Example:

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

certifiedAt[strictly_before]

string<date-time>

Filter by certified date (less than <) Invoice certification date

Example:

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

certifiedAt[after]

string<date-time>

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

Example:

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

certifiedAt[strictly_after]

string<date-time>

Filter by certified date (greater than >) Invoice certification date

Example:

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

lastPaymentDate[before]

string<date-time> | null

Filter by last payment date (less than or equal <=) This field is populated with the last related payment date (Applies only for "PPD" invoices).

lastPaymentDate[strictly_before]

string<date-time> | null

Filter by last payment date (less than <) This field is populated with the last related payment date (Applies only for "PPD" invoices).

lastPaymentDate[after]

string<date-time> | null

Filter by last payment date (greater than or equal >=) This field is populated with the last related payment date (Applies only for "PPD" invoices).

lastPaymentDate[strictly_after]

string<date-time> | null

Filter by last payment date (greater than >) This field is populated with the last related payment date (Applies only for "PPD" invoices).

fullyPaidAt[before]

string<date-time> | null

Filter by fully paid date (less than or equal <=) This field is populated when the total debt is paid. (Applies only for "PPD" invoices).

fullyPaidAt[strictly_before]

string<date-time> | null

Filter by fully paid date (less than <) This field is populated when the total debt is paid. (Applies only for "PPD" invoices).

fullyPaidAt[after]

string<date-time> | null

Filter by fully paid date (greater than or equal >=) This field is populated when the total debt is paid. (Applies only for "PPD" invoices).

fullyPaidAt[strictly_after]

string<date-time> | null

Filter by fully paid date (greater than >) This field is populated when the total debt is paid. (Applies only for "PPD" invoices).

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 true when the CFDI is available in the XML format. The file can be downloaded through the retrieve an invoice CFDI operation

hasPdf

boolean

Filter by invoices that have the CFDI available in PDF format true when the CFDI is available in the PDF format. The file can be downloaded through the retrieve an invoice CFDI operation

order[issuedAt]

enum<string>

Order by issue 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

Collection cursor pointer to the next page

id[gt]

string

Collection cursor pointer to the previous page

itemsPerPage

integer

default:20

Number of items per page

Required range: 1 <= x <= 1000

Response

Taxpayer invoice collection response

@context

string

default:/contexts/Invoice

@id

string

default:/entities/{entityId}/invoices

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices"

@type

string

default:hydra:Collection

hydra:member

object[]

Show child attributes

hydra:view

object

Pagination information

Show child attributes

hydra:search

object

Show child attributes

Core Resources

Other Resources

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Datasource: BIL

Datasource: Infonavit

Insights

Reports

Webhooks

List an entity's invoices

Authorizations

Path Parameters

Query Parameters

Response