POST api/Serial

Request Information

URI Parameters

None.

Body Parameters

SerialModelApi
NameDescriptionTypeAdditional information
GrantorTaxId

RFC

string

Required

Matching regular expression pattern: ^[A-Z&Ñ]{3,4}[0-9]{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])[A-Z0-9]{2}[0-9A]$

Max length: 13

Min length: 12

DocumentTypeId

Tipo de comprobante

DocumentType

None.

Serial

Serie

string

Required

Request Formats

application/json, text/json

Sample:
{
  "GrantorTaxId": "sample string 1",
  "DocumentTypeId": 1,
  "Serial": "sample string 2"
}

application/xml, text/xml

Sample:
<SerialModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GrantorTaxId>sample string 1</GrantorTaxId>
  <DocumentTypeId>Income</DocumentTypeId>
  <Serial>sample string 2</Serial>
</SerialModelApi>

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 'SerialModelApi'.

Response Information

Resource Description

ResponseModelApiOfBoolean
NameDescriptionTypeAdditional 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

boolean

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": true
}

application/xml, text/xml

Sample:
<ResponseModelApiOfBoolean 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>true</data>
</ResponseModelApiOfBoolean>