POST Retention

Add a new Retention

Request Information

URI Parameters

None.

Body Parameters

Retention Request Model information

Name	Description	Type	Additional information
FiscalPeriod	Periodo fiscal	string	Required
FiscalAmount	Importe Total. Formato decimal 0.00	decimal number	None.
Details	Total Impuestos	Collection of RetentionDetailModel	None.
ReferenceDocumentId	ID del Documento Referencia (OPCIONAL Si se envian los datos)	integer	None.
ReferenceDocumentCode	Codigo del Tipo de Documento Referencia (REQUERIDO)	string	None.
ReferenceDocumentNumber	Numero del Documento Referencia (REQUERIDO)	string	None.
ReferenceDocumentDate	Fecha de Emision del Documento Referencia (REQUERIDO)	string	None.
ReferenceDocumentAuth	Numero de Autorizacion del Documento Referencia (OPCIONAL)	string	None.
ReferenceDocumentAmount	Valor Total del Documento Referencia (OPCIONAL)	decimal number	None.
ReferenceDocumentVat	Valor IVA del Documento Referencia (OPCIONAL)	decimal number	None.
IssuedOn	Fecha de Emision del Documento (REQUERIDO)	string	Required
ContributorId	ID de la lista de Contribuyentes (Opcional, si no existe se lo crea automaticamente con la informacion enviada)	integer	None.
IdentificationType	Tipo de identificacion del Contribuyente	string	None.
Identification	Identificacion del Contribuyente	string	None.
ContributorName	Nombre del Contribuyente	string	None.
Phone	Telefono del Contribuyente	string	None.
Address	Direccion del Contribuyente	string	None.
EmailAddresses	Correos a los que se enviara el documento electronico	string	None.
Currency	Moneda (DOLAR de forma predeterminada)	string	None.
Reason	Observaciones	string	None.
Total	Importe Total del Documento. Formato decimal 0.00	decimal number	None.
AdditionalFiels	Campos adicionales	Collection of AdditionalFieldModel	None.
Status	Estado del documento	DocumentStatusEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "FiscalPeriod": "sample string 1",
  "FiscalAmount": 2.0,
  "Details": [
    {
      "RetentionTaxId": 1,
      "TaxTypeCode": "sample string 2",
      "RetentionTaxCode": "sample string 3",
      "TaxBase": 4.0,
      "TaxRate": 5.0,
      "TaxValue": 6.0,
      "ReferenceDocumentCode": "sample string 7",
      "ReferenceDocumentNumber": "sample string 8",
      "ReferenceDocumentDate": "sample string 9"
    },
    {
      "RetentionTaxId": 1,
      "TaxTypeCode": "sample string 2",
      "RetentionTaxCode": "sample string 3",
      "TaxBase": 4.0,
      "TaxRate": 5.0,
      "TaxValue": 6.0,
      "ReferenceDocumentCode": "sample string 7",
      "ReferenceDocumentNumber": "sample string 8",
      "ReferenceDocumentDate": "sample string 9"
    }
  ],
  "ReferenceDocumentId": 1,
  "ReferenceDocumentCode": "sample string 3",
  "ReferenceDocumentNumber": "sample string 4",
  "ReferenceDocumentDate": "sample string 5",
  "ReferenceDocumentAuth": "sample string 6",
  "ReferenceDocumentAmount": 7.0,
  "ReferenceDocumentVat": 8.0,
  "IssuedOn": "sample string 9",
  "ContributorId": 10,
  "IdentificationType": "sample string 11",
  "Identification": "sample string 12",
  "ContributorName": "sample string 13",
  "Phone": "sample string 14",
  "Address": "sample string 15",
  "EmailAddresses": "sample string 16",
  "Currency": "sample string 17",
  "Reason": "sample string 18",
  "Total": 19.0,
  "AdditionalFiels": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "LineNumber": 3
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "LineNumber": 3
    }
  ],
  "Status": 0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Return a Response Message thaht include a HttpStatusCode and the Document Content

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.