Skip to main content
POST
Creates a withholding CFDI

Authorizations

Authorization
string
header
required

HTTP Basic authentication with Facturama username and password.

Body

application/json

CFDI 4.0 Withholdings

FechaExp
string
required

Required attribute for the expression of the date and time of issuance of the withholding and payment information document. Expressed in the form yyyy-mmddThh:mm:ssTZD-6, per ISO 8601.

Minimum string length: 1
Pattern: ^(20[1-9][0-9])-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9])$
CveRetenc
string
required

Required attribute to express the withholding key and payment information according to the catalog published online by SAT.

Minimum string length: 1
Pattern: 0[1-9]|1[0-9]|2[0-6]
Emisor
object
required

Required node to express the information of the issuing taxpayer of the electronic document of withholdings and payment information.

Receptor
object
required

Required node to express the receiver taxpayer information.

Periodo
object
required

Required node to express the period covered by the withholding and payment information document.

Totales
object
required

Required node to express the total withholdings and payment information made in the period covered by the document.

LugarExpRetenc
string
required

Required attribute to include the postal code of the place of issuance of the voucher covering withholdings and payment information.

Minimum string length: 1
FolioInt
string | null

Optional attribute for the taxpayer's internal control that expresses the folio of the document covering the withholding and payment information. Allows numbers and/or letters.

Maximum string length: 20
Pattern: [0-9a-zA-Z]{1,20}
Folio
string | null

Optional attribute for the taxpayer's internal control, This field has the same functionality as the FolioInt field (it is an alias)

Maximum string length: 20
Pattern: [0-9a-zA-Z]{1,20}
DescRetenc
string | null

Optional attribute that expresses the description of the withholding and payment information in case the CveRetenc attribute has the value for 'another type of withholdings'.

Maximum string length: 100
Complemento
object | null

Optional node where the Digital Tax Stamp complement will be included mandatorily and the complementary nodes determined by SAT, in accordance with the specific provisions for a sector or specific activity.

Id
string | null

Unique Facturama identifier

CadenaOriginal
string | null

Original string of the withholding

IsCanceled
boolean

Indicates whether the withholding is cancelled

Sello
string | null

Digital seal of the CFDI (read-only)

Response

200 - application/json

CFDI 4.0 Withholdings

FechaExp
string
required

Required attribute for the expression of the date and time of issuance of the withholding and payment information document. Expressed in the form yyyy-mmddThh:mm:ssTZD-6, per ISO 8601.

Minimum string length: 1
Pattern: ^(20[1-9][0-9])-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9])$
CveRetenc
string
required

Required attribute to express the withholding key and payment information according to the catalog published online by SAT.

Minimum string length: 1
Pattern: 0[1-9]|1[0-9]|2[0-6]
Emisor
object
required

Required node to express the information of the issuing taxpayer of the electronic document of withholdings and payment information.

Receptor
object
required

Required node to express the receiver taxpayer information.

Periodo
object
required

Required node to express the period covered by the withholding and payment information document.

Totales
object
required

Required node to express the total withholdings and payment information made in the period covered by the document.

LugarExpRetenc
string
required

Required attribute to include the postal code of the place of issuance of the voucher covering withholdings and payment information.

Minimum string length: 1
FolioInt
string | null

Optional attribute for the taxpayer's internal control that expresses the folio of the document covering the withholding and payment information. Allows numbers and/or letters.

Maximum string length: 20
Pattern: [0-9a-zA-Z]{1,20}
Folio
string | null

Optional attribute for the taxpayer's internal control, This field has the same functionality as the FolioInt field (it is an alias)

Maximum string length: 20
Pattern: [0-9a-zA-Z]{1,20}
DescRetenc
string | null

Optional attribute that expresses the description of the withholding and payment information in case the CveRetenc attribute has the value for 'another type of withholdings'.

Maximum string length: 100
Complemento
object | null

Optional node where the Digital Tax Stamp complement will be included mandatorily and the complementary nodes determined by SAT, in accordance with the specific provisions for a sector or specific activity.

Id
string | null

Unique Facturama identifier

CadenaOriginal
string | null

Original string of the withholding

IsCanceled
boolean

Indicates whether the withholding is cancelled

Sello
string | null

Digital seal of the CFDI (read-only)