Get tax invoice - Documentación Quentli

{ "id": "txi_1234567890abcdefghij", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "status": "VALID", "customerId": "cus_1234567890abcdefghij", "type": "TAX_INVOICE_PUE", "currency": "MXN", "totalAmount": 150000, "organizationId": "org_1234567890abcdefghij", "issueDate": null, "invoiceId": null, "paymentId": null, "uuid": null, "verificationUrl": null, "folio": null, "failureReason": null, "cancellationStatus": "none", "cancellationMotive": null, "cancelRequestedAt": null, "canceledAt": null, "canceledById": null, "cancellationSubstitution": null, "satType": "I", "paymentForm": "03", "paymentMethod": "PUE", "usage": "G03", "exchangeRate": null, "pdfId": null, "xmlId": null, "createdByUserId": null, "createdByCustomerId": null, "substituteTaxInvoiceId": null }

Authorizations

Authorization

string

header

required

Organization API key using Authorization: Bearer sk_....

Path Parameters

string

required

Identifier of the tax invoice.

Response

object | null

Tax invoice details

Tax invoice details response. Returns null if the tax invoice does not exist.

string

required

Unique identifier of the tax invoice.

Example:

"txi_1234567890abcdefghij"

createdAt

required

When the tax invoice was created.

updatedAt

required

When the tax invoice was last updated.

status

enum<string>

required

Current tax invoice status.

Available options:

VALID,

CANCELED,

PENDING,

DRAFT,

PENDING_CANCELLATION,

FAILED

Example:

"VALID"

customerId

string

required

Customer identifier.

Example:

"cus_1234567890abcdefghij"

type

enum<string>

required

Quentli tax invoice type.

Available options:

TAX_RECEIPT,

TAX_INVOICE_PPD,

TAX_INVOICE_PUE

Example:

"TAX_INVOICE_PUE"

currency

string

required

ISO 4217 currency code.

Example:

"MXN"

totalAmount

number

required

Tax invoice total amount in minor units.

Example:

150000

organizationId

string

required

Owning organization identifier.

Example:

"org_1234567890abcdefghij"

issueDate

Date when the tax invoice was issued.

Example:

null

invoiceId

string | null

Related invoice identifier, if any.

Example:

null

paymentId

string | null

Related payment identifier, if any.

Example:

null

uuid

string | null

SAT UUID assigned to the tax invoice.

Example:

null

verificationUrl

string | null

SAT verification URL.

Example:

null

folio

string | null

Tax invoice folio.

Example:

null

failureReason

string | null

Normalized issuance failure reason, if any.

Example:

null

cancellationStatus

string | null

SAT cancellation status.

Example:

"none"

cancellationMotive

string | null

SAT cancellation motive code.

Example:

null

cancelRequestedAt

Date and time when cancellation was requested.

Example:

null

canceledAt

Date and time when cancellation completed.

Example:

null

canceledById

string | null

User that requested cancellation.

Example:

null

cancellationSubstitution

string | null

Substitution UUID used for cancellation motive 01.

Example:

null

satType

string | null

SAT invoice type code.

Example:

"I"

paymentForm

string | null

SAT payment form.

Example:

"03"

paymentMethod

string | null

SAT payment method.

Example:

"PUE"

usage

string | null

CFDI usage code.

Example:

"G03"

exchangeRate

number | null

Exchange rate used for non-MXN invoices.

Example:

null

pdfId

string | null

PDF file identifier, if available.

Example:

null

xmlId

string | null

XML file identifier, if available.

Example:

null

createdByUserId

string | null

User who created this tax invoice.

Example:

null

createdByCustomerId

string | null

Customer who created this tax invoice.

Example:

null

substituteTaxInvoiceId

string | null

Tax invoice that substituted this one, if any.

Example:

null