POST api/Document/

Agregar un documento CFDI, será necesario enviar un multipart/form-data. El primero con los datos generales en formato JSON del documento. El segundo con el comprobante xml original, de este último se toma información adicional del documento.

Request Information

URI Parameters

None.

Body Parameters

Layout con información adicional requerida para la integración de un CFDI

DocumentLoadModelApi

Name	Description	Type	Additional information
Fiscal_Address	Dirección fiscal	FiscalAddressModelApi	None.
Customer	Información básica del cliente	CustomerBasicModelApi	Required
CustomerContact	Información de contacto	ContactInfoModelApi	Required
PaymentFrequency	Frecuencia de pago	PaymentFrequency	None.
InvoiceDocumentTypeId	Tipo de documento default(Factura)	InvoiceDocumentType	None.
ReferenceDocumentId	Identificador de la referencia del documento	globally unique identifier	None.
DocumentDocumentRelated	Lista de referencias del documento	Collection of DocumentDocumentRelatedModelApi	None.
ExpectedPaymentDate	Fecha esperada de pago	date	None.
DueDays	Días de plazo para pagarse	integer	None.
PaymentReferences	Referencias de pago externas para que le aparezcan al Cliente del asociado, como referencia adicional a los pagos que maneja. Ejemplo el integrador maneja pago en Oxxo y la plataforma no maneja, al mandar estas referencia a la hora de que el Cliente del asociado trate de hacer el pago aparecen los medios de pago proporcionados por la plataforma y adicional los medios de pago enviados en esta colección.	Collection of DocumentPaymentReferenceModelApi	None.
ExtendedDueDate	Fecha de morosidad	date	None.
BeginningBalance	Saldo inicial del documento	decimal number	None.
ExternalStatementAccountURL		string	None.
DueDate	Fecha de vencimiento	date	None.
ExternalRecurrenceId	Id de recurrencia externa	globally unique identifier	None.
SellerExternalId	Código del vendedor	string	None.
BranchExternalId	Código de la sucursal	string	None.
DocumentCategoryCode	Código de la categoría	string	None.
ExchangeRate	Tipo de Cambio	decimal number	None.
ExchangeRateTypeId	Si el tipo de cambio es fijo o variable	integer	None.
IsUncollectibleDebt	Marcar como incobrable el documento	boolean	None.
FileName	Nombre del archivo (mismo para el xml y pdf)	string	None.
IsMigrated	Marcar como migrado el documento	boolean	None.
Parciality	Informacion para poder aplicar parcialidades a la factura	ParcialityInfo	None.
GrantorTaxId		string	Required
CountryIsoCode		string	None.
PersonalTypeId		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "Fiscal_Address": {
    "City": "sample string 1",
    "ExternalNumber": "sample string 2",
    "InternalNumber": "sample string 3",
    "District": "sample string 4",
    "Municipality": "sample string 5",
    "Street": "sample string 6",
    "State": "sample string 7",
    "ZipCode": "sample string 8",
    "Country": "sample string 9"
  },
  "Customer": {
    "Citizenship": "sample string 1",
    "PersonalCodeNumber": "sample string 2",
    "CustomerTypeId": 3,
    "DeliveryPortal": true,
    "UrlDeliveryPortal": "sample string 4",
    "UserDeliveryPortal": "sample string 5",
    "PassDeliveryPortal": "sample string 6",
    "CustomerCode": "sample string 7",
    "ResidenceTax": "sample string 8",
    "NumRegIdTrib": "sample string 9"
  },
  "CustomerContact": {
    "CustomerContactInfoesId": "08dd2e4d-52a1-0e54-522b-6e3108c3f9a3",
    "Email": "sample string 1",
    "Phone": "sample string 2",
    "CellPhone": "sample string 3",
    "PrefixPhone": "sample string 4",
    "PrefixCellphone": "sample string 5",
    "ContactName": "sample string 6",
    "PhoneActive": true,
    "EmailActive": true,
    "CellphoneActive": true,
    "REPNotification": true,
    "NewDocumentNotification": true,
    "CollectiontNotification": true
  },
  "PaymentFrequency": 1,
  "InvoiceDocumentTypeId": 1,
  "ReferenceDocumentId": "08dd2e4d-52a1-0e54-522b-6e3108c3f9a4",
  "DocumentDocumentRelated": [
    {
      "DocumentRelatedId": "08dd2e4d-52a1-0e54-522b-6e3108c3f9a5",
      "Amount": 1.0,
      "RelatedType": "sample string 2"
    },
    {
      "DocumentRelatedId": "08dd2e4d-52a1-0e54-522b-6e3108c3f9a5",
      "Amount": 1.0,
      "RelatedType": "sample string 2"
    }
  ],
  "ExpectedPaymentDate": "2025-01-06T06:26:19.0124628-06:00",
  "DueDays": 1,
  "PaymentReferences": [
    {
      "Bank": "sample string 1",
      "AgreementName": "sample string 2",
      "AccountNumber": "sample string 3",
      "AgreementNumber": "sample string 4",
      "Reference": "sample string 5",
      "BarCodeName": "sample string 6"
    },
    {
      "Bank": "sample string 1",
      "AgreementName": "sample string 2",
      "AccountNumber": "sample string 3",
      "AgreementNumber": "sample string 4",
      "Reference": "sample string 5",
      "BarCodeName": "sample string 6"
    }
  ],
  "ExtendedDueDate": "2025-01-06T06:26:19.0124628-06:00",
  "BeginningBalance": 1.0,
  "ExternalStatementAccountURL": "sample string 1",
  "DueDate": "2025-01-06T06:26:19.0124628-06:00",
  "ExternalRecurrenceId": "08dd2e4d-52a1-0e54-522b-6e3108c3f9a6",
  "SellerExternalId": "sample string 2",
  "BranchExternalId": "sample string 3",
  "DocumentCategoryCode": "sample string 4",
  "ExchangeRate": 5.0,
  "ExchangeRateTypeId": 1,
  "IsUncollectibleDebt": true,
  "FileName": "sample string 7",
  "IsMigrated": true,
  "Parciality": {
    "ParcialityType": 1,
    "Periodicity": 1,
    "NumberOfParcialities": 1,
    "Parcialities": [
      {
        "Date": "2025-01-06T06:26:19.0124628-06:00",
        "Percentage": 2.0
      },
      {
        "Date": "2025-01-06T06:26:19.0124628-06:00",
        "Percentage": 2.0
      }
    ]
  },
  "GrantorTaxId": "sample string 8",
  "CountryIsoCode": "sample string 9",
  "PersonalTypeId": 1
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentLoadModelApi'.

Response Information

Resource Description

El resultado de la solicitud dará como resultado el UUID de integración resultante y un código HTTP 200 Ok

ResponseModelApiOfDocumentResultModelApi

Name	Description	Type	Additional information
success	Indica si la solicitud se procesó de manera satisfactoria	boolean	None.
message	Mensaje de la solicitud	string	None.
messageDetail	Lista de mensajes	Collection of string	None.
failureCode	Código de error en caso de existir	string	None.
data	Layout de respuesta de la solicitud	DocumentResultModelApi	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "messageDetail": [
    "sample string 1",
    "sample string 2"
  ],
  "failureCode": "sample string 3",
  "data": {
    "DocumentId": "sample string 1"
  }
}

application/xml, text/xml

Sample:

<ResponseModelApiOfDocumentResultModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
  <message>sample string 2</message>
  <messageDetail>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </messageDetail>
  <failureCode>sample string 3</failureCode>
  <data>
    <DocumentId>sample string 1</DocumentId>
  </data>
</ResponseModelApiOfDocumentResultModelApi>