Retrieve an invoice line item

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

{
  "@id": "/invoices/line-items/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "InvoiceLineItem",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "invoice": {
    "@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"
      }
    ]
  },
  "identificationNumber": "<string>",
  "productIdentification": 50121537,
  "description": "Apple iPhone",
  "unitAmount": 70,
  "unitCode": "KGM",
  "quantity": 60,
  "discountAmount": 0,
  "totalAmount": 4200,
  "retainedTaxes": {
    "valueAddedTax": 0,
    "incomeTax": 0,
    "sinTax": 0
  },
  "transferredTaxes": {
    "valueAddedTax": 0,
    "sinTax": 0
  }
}

GET

line-items

{id}

Retrieve an invoice line item

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

{
  "@id": "/invoices/line-items/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "InvoiceLineItem",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "invoice": {
    "@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"
      }
    ]
  },
  "identificationNumber": "<string>",
  "productIdentification": 50121537,
  "description": "Apple iPhone",
  "unitAmount": 70,
  "unitCode": "KGM",
  "quantity": 60,
  "discountAmount": 0,
  "totalAmount": 4200,
  "retainedTaxes": {
    "valueAddedTax": 0,
    "incomeTax": 0,
    "sinTax": 0
  },
  "transferredTaxes": {
    "valueAddedTax": 0,
    "sinTax": 0
  }
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

string<uuid>

required

Invoice Line Item ID

Example:

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

Response

Invoice Line Items response

@id

string<iri-reference>

Invoice Line Item IRI reference

Example:

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

@type

string

default:InvoiceLineItem

string<uuid>

Invoice line item ID

Example:

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

invoice

object

Show child attributes

invoice.@id

string<iri-reference>

Invoice IRI reference

Example:

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

invoice.@type

string

default:Invoice

invoice.id

string<uuid>

Invoice ID

Example:

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

invoice.uuid

string<uuid>

Invoice UUID (Folio fiscal)

Example:

"def404af-5eef-4112-aa99-d1ec8493b89a"

invoice.version

number<float> | null

CFDI version

Example:

3.3

invoice.reference

string | null

It is an open field for internal identification. Communly it is used to identify a branch

Maximum string length: 25

Example:

"Branch-A"

invoice.internalIdentifier

string | null

It is an open field for internal identification. Communly it is used to identify an invoice

Maximum string length: 40

Example:

"00001"

invoice.type

enum<string>

Invoice type code from c_TipoDeComprobante catalog

Available options:

I,

E,

P,

N,

T

invoice.usage

string | null

Invoice usage code from c_UsoCFDI catalog

Example:

"G03"

invoice.paymentType

enum<string> | null

Payment type code from c_MetodoPago catalog

Available options:

PUE,

PPD

Example:

"PUE"

invoice.paymentMethod

string | null

Payment method code from c_FormaPago catalog

Example:

"04"

invoice.paymentTerms

enum<string> | null

Payment terms

Available options:

immediate_payment,

net_0,

net_15,

net_30,

net_45,

net_90,

net_120

Example:

"immediate_payment"

invoice.placeOfIssue

string

Postal code of the place of issue

Example:

"01210"

invoice.issuer

object

Show child attributes

invoice.issuer.rfc

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

invoice.issuer.name

string

Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

invoice.issuer.taxRegime

number | null

Tax regime code from c_RegimenFiscal catalog

Example:

601

invoice.issuer.blacklistStatus

enum<string> | null

Show the blacklist status if a taxpayer is found in the list 69-B from SAT

Available options:

presumed,

dismissed,

definitive,

favorable

Example:

"presumed"

Example:

{
  "rfc": "AOM920820BEA",
  "name": "APPLE OPERATIONS MEXICO S.A. DE C.V.",
  "taxRegime": 601,
  "blacklistStatus": null
}

invoice.isIssuer

boolean

true if the invoice issuer is the taxpayer from the entity

Example:

true

invoice.receiver

object

Show child attributes

invoice.receiver.rfc

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

invoice.receiver.name

string

Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

invoice.receiver.blacklistStatus

enum<string> | null

Show the blacklist status if a taxpayer is found in the list 69-B from SAT

Available options:

presumed,

dismissed,

definitive,

favorable

Example:

"presumed"

invoice.isReceiver

boolean

true if the invoice receiver is the taxpayer from the entity

Example:

false

invoice.currency

string | null

ISO 4217 alphabetic currency code

Required string length: 3

Example:

"MXN"

invoice.discount

number<float>

Discount amount

Example:

3324

invoice.tax

number<float>

Tax amount

Example:

5224

invoice.subtotal

number<float>

Subtotal amount

Example:

51349.8

invoice.creditedAmount

number<float> | null

Credited amount

Example:

31.32

invoice.subtotalCreditedAmount

number<float> | null

Subtotal credited amount

Example:

27

invoice.total

number<float>

Invoice total amount

Example:

53249.8

invoice.exchangeRate

number<float> | null

Set when currency is different than MXN (Mexican Peso).

Example:

19.8

invoice.paidAmount

number<float>

For a deferred invoice this field state the paid amount. (Applies only for "PPD" invoices).

Example:

53249.8

invoice.dueAmount

number<float>

For a deferred invoice this field state the due amount. (Applies only for "PPD" invoices).

Example:

0

invoice.lastPaymentDate

string<date-time> | null

This field is populated with the last related payment date (Applies only for "PPD" invoices).

invoice.fullyPaidAt

string<date-time> | null

This field is populated when the total debt is paid. (Applies only for "PPD" invoices).

invoice.paymentTermsRaw

string | null

The invoice payment terms text exactly as it comes from the invoice, i.e. immediate, 30 days, cash, credit card, etc

Example:

"Tarjeta de crédito"

invoice.status

enum<string>

Whether the invoice is active or canceled

Available options:

VIGENTE,

CANCELADO

Example:

"VIGENTE"

invoice.pac

string

Certification provider tax ID (Proveedor Autorizado de Certificación)

Required string length: 12

Example:

"SAT970701NN3"

invoice.issuedAt

string<date-time>

Invoice issue date

Example:

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

invoice.certifiedAt

string<date-time>

Invoice certification date

Example:

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

invoice.cancellationStatus

enum<string>

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"

invoice.cancellationProcessStatus

enum<string> | null

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"

invoice.canceledAt

string<date-time> | null

Set when status is CANCELADO

invoice.relations

object[]

Show child attributes

invoice.relations.@id

string<iri-reference>

Invoice Relation IRI reference

Example:

"/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1"

invoice.relations.@type

string

default:InvoiceRelation

invoice.relations.id

string<uuid>

Invoice relation ID

Example:

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

invoice.relations.type

number

Invoice relation type code from c_TipoRelacion catalog

Example:

7

invoice.relations.invoice

string<iri-reference>

Invoice IRI reference

Example:

"/invoices/92106967-2abd-5d64-95c2-4e73d96fb998"

Invoice IRI reference

Example:

"/invoices/92106967-2abd-5d64-95c2-4e73d96fb998"

The related Invoice UUID (Folio fiscal)

Example:

"def404af-5eef-4112-aa99-d1ec8493b89a"

invoice.relations.createdAt

string

Date and time the resource was created

Example:

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

invoice.relations.updatedAt

string

Date and time the resource was last updated

Example:

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

invoice.xml

boolean

true when the CFDI is available in the XML format. The file can be downloaded through the retrieve an invoice CFDI operation

invoice.pdf

boolean

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

invoice.createdAt

string

Date and time the resource was created

Example:

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

invoice.updatedAt

string

Date and time the resource was last updated

Example:

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

invoice.tags

object[]

Show child attributes

invoice.tags.@id

string<iri-reference>

Resource tag IRI reference

Example:

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

invoice.tags.@type

string

default:Tag

invoice.tags.id

string<uuid>

Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

invoice.tags.name

string

Example:

"To be reviewed"

invoice.tags.createdAt

string

Date and time the resource was created

Example:

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

invoice.tags.updatedAt

string

Date and time the resource was last updated

Example:

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

identificationNumber

string | null

productIdentification

string

Example:

50121537

description

string

Example:

"Apple iPhone"

unitAmount

number<double>

Example:

70

unitCode

string

Example:

"KGM"

quantity

number<double>

Example:

60

discountAmount

number<double>

Example:

0

totalAmount

number<double>

Example:

4200

retainedTaxes

object

Show child attributes

retainedTaxes.valueAddedTax

number<double>

Example:

0

retainedTaxes.incomeTax

number<double>

Example:

0

retainedTaxes.sinTax

number<double>

Example:

0

transferredTaxes

object

Show child attributes

transferredTaxes.valueAddedTax

number<double>

Example:

0

transferredTaxes.sinTax

number<double>

Example:

0

List invoices List an invoice's line items

⌘I

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

Miscellaneous

Retrieve an invoice line item

Authorizations

Path Parameters

Response