GET GetPrefixes

Listar los prefijo de una compañía

Request Information

URI Parameters

None.

Body Parameters

tipo de documento a obtener. 1 facturas, 2 notas créditos, 3 notas débito

Name	Description	Type	Additional information
documentTypeCode	Tipo de documento.	integer	Range: inclusive between 1 and 5

Request Formats

application/json, text/json

Sample:

{
  "documentTypeCode": 1
}

application/xml, text/xml

Sample:

<DocumentTypeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">
  <documentTypeCode>1</documentTypeCode>
</DocumentTypeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PrefixData

Name	Description	Type	Additional information
fileTypeCode	Código de tipo de documento para el cual sera el prefijo 1 para factura 2 para nota crédito 3 para nota débito	integer	Range: inclusive between 1 and 5
prefix	Prefijo dado por la DIAN	string	Required String length: inclusive between 0 and 5
description	Descripción del prefijo	string	Required String length: inclusive between 0 and 200
startNumeration	Inicio de la numeración	integer	Range: inclusive between 1 and 9999999999
endNumeration	Final de la numeración	integer	Range: inclusive between 1 and 9999999999
nameTemplate	nombre de la plantilla. La plantilla debe existir. Se modifica la plantilla relacionada, no el nombre	string	Required String length: inclusive between 0 and 50
resolutionNumber	numero de resolución entregado por la DIAN para el prefijo a crear	string	String length: inclusive between 0 and 100
dateResolutionFrom	Fecha inicial de la resolución	date	Optional
dateResolutionTo	Fecha final de la resolución	date	Optional
technicalKey	Llave tecnica del prefijo	string	String length: inclusive between 0 and 200
active	Estado del prefijo en el sistema (Activado o desactivado)	boolean	Required
isContingency	Indica si el prefijo es de contingencia	boolean	Optional

Response Formats

application/json, text/json

Sample:

[
  {
    "fileTypeCode": 1,
    "prefix": "sample string 2",
    "description": "sample string 3",
    "startNumeration": 4,
    "endNumeration": 5,
    "nameTemplate": "sample string 6",
    "resolutionNumber": "sample string 7",
    "dateResolutionFrom": "2024-04-29T00:39:00.6393378-05:00",
    "dateResolutionTo": "2024-04-29T00:39:00.6393378-05:00",
    "technicalKey": "sample string 8",
    "active": true,
    "isContingency": true
  },
  {
    "fileTypeCode": 1,
    "prefix": "sample string 2",
    "description": "sample string 3",
    "startNumeration": 4,
    "endNumeration": 5,
    "nameTemplate": "sample string 6",
    "resolutionNumber": "sample string 7",
    "dateResolutionFrom": "2024-04-29T00:39:00.6393378-05:00",
    "dateResolutionTo": "2024-04-29T00:39:00.6393378-05:00",
    "technicalKey": "sample string 8",
    "active": true,
    "isContingency": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfPrefixData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">
  <PrefixData>
    <active>true</active>
    <dateResolutionFrom>2024-04-29T00:39:00.6393378-05:00</dateResolutionFrom>
    <dateResolutionTo>2024-04-29T00:39:00.6393378-05:00</dateResolutionTo>
    <description>sample string 3</description>
    <endNumeration>5</endNumeration>
    <fileTypeCode>1</fileTypeCode>
    <isContingency>true</isContingency>
    <nameTemplate>sample string 6</nameTemplate>
    <prefix>sample string 2</prefix>
    <resolutionNumber>sample string 7</resolutionNumber>
    <startNumeration>4</startNumeration>
    <technicalKey>sample string 8</technicalKey>
  </PrefixData>
  <PrefixData>
    <active>true</active>
    <dateResolutionFrom>2024-04-29T00:39:00.6393378-05:00</dateResolutionFrom>
    <dateResolutionTo>2024-04-29T00:39:00.6393378-05:00</dateResolutionTo>
    <description>sample string 3</description>
    <endNumeration>5</endNumeration>
    <fileTypeCode>1</fileTypeCode>
    <isContingency>true</isContingency>
    <nameTemplate>sample string 6</nameTemplate>
    <prefix>sample string 2</prefix>
    <resolutionNumber>sample string 7</resolutionNumber>
    <startNumeration>4</startNumeration>
    <technicalKey>sample string 8</technicalKey>
  </PrefixData>
</ArrayOfPrefixData>