Saltar al contenido principal

Folio Manager Configuration

SBXhttps://developers-sbx.gosocket.net/number-manager-admin
PRDhttps://developers.gosocket.net/number-manager-admin

Gestor de Folios 3.0

Endpoints para configurar el Folio Manager vía API, replicando las acciones del portal. Se usa en países que requieren descarga de folios desde la entidad tributaria: CL (SII) y CO. En evaluación: CR, PY, UY.

Generalidades del proceso

  • Para todas las APIs involucradas se utiliza el método de autenticación OAuth 2.0.
  • La verificación de los umbrales de recarga, y en consecuencia la ejecución de dicha recarga si se alcanza el umbral, se realiza cada 2 horas, tanto para los rangos primarios como para los subrangos.

0. AccessToken

Method: POST

Este endpoint permite obtener el token de autenticación. Se debe enviar un par de claves ApiKey utilizando el método OAuth2.0.
El token generado tiene una vigencia de 2 horas.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/oauth2/token

URL PRD

https://developers.gosocket.net/number-manager-admin/oauth2/token


Request

{
"grant_type": "client_credentials",
"client_id": "{{CLIENT_ID}}",
"client_secret": "{{CLIENT_SECRET}}"
}

Response

{
"access_token": "{{ACCESS_TOKEN}}",
"token_type": "bearer",
"expires_in": 7200
}

1. AddBiller

Method: POST

Este endpoint permite crear el billerId asociado a la cuenta del cliente.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/AddBiller

URL PRD

https://developers.gosocket.net/number-manager-admin/AddBiller


Request

{
"billerType": 2,
"name": "Biller-TR-Documentacion",
"description": "Biller-TR test-Documentacion",
"author": "user@empresa.com",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"smartRefill": true,
"source": "Postman"
}

📝 billerType debe ser siempre 2 (biller centralizado). Establece smartRefill: true para que los subrangos se recarguen automáticamente.

Response

{
"code": 200,
"message": "",
"data": {
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"billerType": 2,
"name": "Biller-TR-Documentacion",
"billingPoint": null,
"salePoint": null,
"description": "Biller-TR test-Documentacion",
"dateTimeTimestamp": "2025-07-25T05:43:35.0442759Z",
"author": "user@empresa.com",
"lastChangeAuthor": null,
"lastChangeTimestamp": "0001-01-01T00:00:00",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"status": 1,
"statusDescription": null,
"enabled": true,
"smartRefill": true,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null,
"source": "Postman",
"thresholds": [],
"configurations": []
},
"isSuccess": true
}

1.1 UpdateBiller

Method: POST

Este endpoint permite actualizar un billerId existente en la cuenta del cliente.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/UpdateBiller

URL PRD

https://developers.gosocket.net/number-manager-admin/UpdateBiller


Request

{
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"name": "Biller-TR-Documentacion_actualizar_billerId",
"description": "Biller-TR test-Documentacion_actualizar_billerId",
"author": "user@empresa.com",
"smartRefill": false,
"enabled": true,
"source": "Postman"
}

Response

{
"code": 200,
"message": "",
"data": {
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"billerType": 2,
"name": "Biller-TR-Documentacion_actualizar_billerId",
"billingPoint": null,
"salePoint": null,
"description": "Biller-TR test-Documentacion_actualizar_billerId",
"dateTimeTimestamp": "2025-07-25T05:43:35.0442759Z",
"author": "user@empresa.com",
"lastChangeAuthor": "user@empresa.com",
"lastChangeTimestamp": "2025-07-25T05:50:20.5171138Z",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"status": 1,
"statusDescription": null,
"enabled": true,
"smartRefill": false,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null,
"source": "Postman",
"thresholds": [],
"configurations": []
},
"isSuccess": true
}

1.1.2 GetBillerById

Method: GET

Permite obtener la información asociada a un billerId específico dentro de una cuenta.


URL SBX

https://inbox-emission-numbermanager-all-adminapi-sbx.azurewebsites.net/GetBillerById

URL PRD

https://inbox-emission-numbermanager-all-adminapi.azurewebsites.net/GetBillerById


Request

{
"countryId": "cl",
"accountCode": "{{taxId}}",
"id": "df5d9280-3706-4736-8722-22cd63224460"
}

Response

{
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"billerType": 2,
"name": "Biller-TR-Documentacion",
"billingPoint": null,
"salePoint": null,
"description": "Biller-TR test-Documentacion",
"dateTimeTimestamp": "2025-07-25T05:43:35.0442759Z",
"author": "user@empresa.com",
"lastChangeAuthor": "user@empresa.com",
"lastChangeTimestamp": "2025-07-25T05:51:13.7845021Z",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"status": 1,
"statusDescription": null,
"enabled": true,
"smartRefill": true,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null,
"source": "Postman",
"thresholds": [],
"configurations": []
}

1.2 SaveBillerConfiguration

Method: POST

Este endpoint permite definir el tamaño de los subrangos con los que se recargará el gestor de folios, por tipo de documento.
Si no se configura explícitamente, se aplicará un subrango por defecto de 100 folios.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/SaveBillerConfiguration

URL PRD

https://developers.gosocket.net/number-manager-admin/SaveBillerConfiguration


Request

{
"countryId": "cl",
"accountCode": "{{taxId}}",
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"documentTypeId": 33,
"refill": 50,
"author": "user@empresa.com"
}

Response

{
"code": 200,
"message": "",
"data": {
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"billerType": 2,
"name": "Biller-TR-Documentacion",
"billingPoint": null,
"salePoint": null,
"description": "Biller-TR test-Documentacion",
"dateTimeTimestamp": "2025-07-25T05:43:35.0442759Z",
"author": "user@empresa.com",
"lastChangeAuthor": "user@empresa.com",
"lastChangeTimestamp": "2025-07-25T05:51:13.7845021Z",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"status": 1,
"statusDescription": null,
"enabled": true,
"smartRefill": true,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null,
"source": "Postman",
"thresholds": [],
"configurations": [
{
"id": "28c10298-28cf-474b-b1ba-320a8836d3f6",
"documentTypeId": 33,
"documentTypeDescription": null,
"refill": 50,
"author": "user@empresa.com",
"dateTimeTimestamp": "2025-07-25T15:28:43.7844933Z",
"lastChangeAuthor": null,
"lastChangeTimestamp": null,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null
}
]
},
"isSuccess": true
}

1.2.1 DeleteBillerConfiguration

Method: DELETE

Este endpoint permite eliminar la configuración de recarga automática de subrangos previamente establecida para un billerId.


URL SBX

https://inbox-emission-numbermanager-all-adminapi-sbx.azurewebsites.net/DeleteBillerConfiguration

URL PRD

https://inbox-emission-numbermanager-all-adminapi.azurewebsites.net/DeleteBillerConfiguration


Request

{
"billerConfigurationId": "28c10298-28cf-474b-b1ba-320a8836d3f6",
"countryId": "cl",
"accountCode": "{{taxId}}",
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"author": "user@empresa.com"
}

Response

{
"code": 200,
"message": "BillerConfiguration removed",
"data": null,
"isSuccess": true
}

1.3 SaveBillerThreshold

Method: POST

Permite definir el umbral de recarga automática de subrangos para cada tipo de documento.
Si no se establece explícitamente, se aplicará un umbral por defecto de 100 folios.

Nota: El umbral de recarga indica el momento en que se debe activar la recarga automática.
Por ejemplo, si se define un umbral de 10, cuando la cantidad de folios disponibles en el subrango sea igual o menor a ese valor, el gestor de folios recargará automáticamente un nuevo subrango con el tamaño definido previamente en el punto 1.2 SaveBillerConfiguration.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/SaveBillerThreshold

URL PRD

https://developers.gosocket.net/number-manager-admin/SaveBillerThreshold


Request

{
"countryId": "cl",
"accountCode": "{{taxId}}",
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"documentTypeId": 33,
"threshold": 10,
"author": "user@empresa.com"
}

Response

{
"code": 200,
"message": "",
"data": {
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"billerType": 2,
"name": "Biller-TR-Documentacion",
"billingPoint": null,
"salePoint": null,
"description": "Biller-TR test-Documentacion",
"dateTimeTimestamp": "2025-07-25T05:43:35.0442759Z",
"author": "user@empresa.com",
"lastChangeAuthor": "user@empresa.com",
"lastChangeTimestamp": "2025-07-25T05:51:13.7845021Z",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"status": 1,
"statusDescription": null,
"enabled": true,
"smartRefill": true,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null,
"source": "Postman",
"thresholds": [
{
"id": "058f81b4-d96f-4636-99ad-29d73bd9c9f2",
"documentTypeId": 33,
"documentTypeDescription": null,
"threshold": 10,
"author": "user@empresa.com",
"dateTimeTimestamp": "2025-07-25T15:39:10.7419006Z",
"lastChangeAuthor": null,
"lastChangeTimestamp": null,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null
}
],
"configurations": [
{
"id": "28c10298-28cf-474b-b1ba-320a8836d3f6",
"documentTypeId": 33,
"documentTypeDescription": null,
"refill": 50,
"author": "user@empresa.com",
"dateTimeTimestamp": "2025-07-25T15:28:43.7844933Z",
"lastChangeAuthor": null,
"lastChangeTimestamp": null,
"deleted": true,
"deletedAuthor": "user@empresa.com",
"deletedTimeStamp": "2025-07-25T15:32:41.6170471Z"
},
{
"id": "6d045ab9-0c5d-4516-8a07-822b9465eefa",
"documentTypeId": 33,
"documentTypeDescription": null,
"refill": 50,
"author": "user@empresa.com",
"dateTimeTimestamp": "2025-07-25T15:38:52.0121753Z",
"lastChangeAuthor": null,
"lastChangeTimestamp": null,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null
}
]
},
"isSuccess": true
}

1.3.1 DeleteBillerThreshold

Method: DELETE

Este endpoint permite eliminar la configuración del umbral de recarga de subrangos definida previamente para un billerId.


URL SBX

https://inbox-emission-numbermanager-all-adminapi-sbx.azurewebsites.net/DeleteBillerThreshold

URL PRD

https://inbox-emission-numbermanager-all-adminapi.azurewebsites.net/DeleteBillerThreshold


Request

{
"billerThresholdId": "058f81b4-d96f-4636-99ad-29d73bd9c9f2",
"countryId": "cl",
"accountCode": "{{taxId}}",
"billerId": "df5d9280-3706-4736-8722-22cd63224460",
"author": "user@empresa.com"
}

Response

{
"code": 200,
"message": "BillerThreshold removed",
"data": null,
"isSuccess": true
}

2. DownloadPrimaryRangeET

Method: POST

Permite descargar folios desde el SII para cada tipo de documento.
Para realizar la solicitud se debe proporcionar el billerId, el tipo de documento, y la cantidad de folios que se desea descargar.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/DownloadPrimaryRangeET

URL PRD

https://developers.gosocket.net/number-manager-admin/DownloadPrimaryRangeET


Request

{
"accountCode": "{{taxId}}",
"countryId": "cl",
"billers": [
"df5d9280-3706-4736-8722-22cd63224460"
],
"author": "user@empresa.com",
"documentTypeId": 33,
"countNumbers": 5
}

Response

{
"code": 200,
"message": "La descarga de rangos desde la entidad tributaria ha finalizado correctamente",
"data": null,
"isSuccess": true
}

2.1 GetPrimaryRangeByFilter

Method: POST

Permite obtener información de los rangos primarios asociados a un billerId específico dentro de una cuenta.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/GetPrimaryRangesByFilter

URL PRD

https://developers.gosocket.net/number-manager-admin/GetPrimaryRangesByFilter


Request

{
"accountCode": "{{taxId}}",
"countryId": "cl",
"billerId": "df5d9280-3706-4736-8722-22cd63224460"
}

Response

[
{
"primaryRangeId": "afc4ad1d-0a04-47e6-89a1-e07f195771b9",
"billingPoint": null,
"salePoint": null,
"primaryRangeType": 1,
"priorityLevel": 0,
"number": 21343,
"numberMin": 21344,
"numberMax": 21348,
"series": null,
"documentTypeId": 33,
"dateFrom": "2025-07-25T00:00:00",
"dateFromNumber": 20250725,
"dateTo": "2026-01-25T00:00:00",
"dateToNumber": 20260125,
"dateTimeTimestamp": "2025-07-25T15:49:26.4013812Z",
"author": "",
"data": "<XML_CAF_OMITIDO>",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"status": 1,
"enabled": true,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null,
"source": "SII",
"billers": [
"df5d9280-3706-4736-8722-22cd63224460"
]
}
]

2.2 GetPrimaryRangeById

Method: GET

Endpoint para obtener información de un rango primario especifico de la cuenta a través de su Id.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/GetPrimaryRangeById

URL PRD

https://developers.gosocket.net/number-manager-admin/GetPrimaryRangeById


Request

image-20250725-160934.png

Response

{
"primaryRangeId": "afc4ad1d-0a04-47e6-89a1-e07f195771b9",
"billingPoint": null,
"salePoint": null,
"primaryRangeType": 1,
"priorityLevel": 0,
"number": 21343,
"numberMin": 21344,
"numberMax": 21348,
"series": null,
"documentTypeId": 33,
"dateFrom": "2025-07-25T00:00:00",
"dateFromNumber": 20250725,
"dateTo": "2026-01-25T00:00:00",
"dateToNumber": 20260125,
"dateTimeTimestamp": "2025-07-25T15:49:26.4013812Z",
"author": "",
"data": "<XML_CAF_OMITIDO>",
"countryId": "cl",
"accountCode": "{{taxId}}",
"accountName": "Nombre Empresa",
"status": 1,
"enabled": true,
"deleted": false,
"deletedAuthor": null,
"deletedTimeStamp": null,
"source": "SII",
"billers": [
"df5d9280-3706-4736-8722-22cd63224460"
]
}

3. GetBillerSubRanges

Method: GET

Permite obtener los subrangos asociados a un billerId específico dentro de una cuenta.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/GetBillerSubRanges

URL PRD

https://developers.gosocket.net/number-manager-admin/GetBillerSubRanges


Request

image-20250725-161946.png

Response

[
{
"countryId": "cl",
"accountCode": "{{taxId}}",
"subRangeId": "1ebf98c8-a368-440d-90f3-7c99b5a59c4c",
"primaryRangeId": "7e9b0f7d-098e-1475-6aab-4f73d3200c9a",
"billerId": "a06bb722-88ea-4f91-be1d-03e91531470b",
"dateTimeTimestamp": "2023-09-25T21:48:57.5675843Z",
"documentTypeId": 1,
"series": null,
"actualNumber": 10,
"actualNumberLastUpdate": "2023-09-25T21:54:46.142222Z",
"actualNumberLastUpdateSource": "System",
"numberFrom": 1,
"numberTo": 10,
"dateTo": null,
"author": "System",
"deleted": false,
"status": 5,
"data": null
},
{
"countryId": "cl",
"accountCode": "{{taxId}}",
"subRangeId": "855614d5-f1de-448a-b4e1-8135b9ab575d",
"primaryRangeId": "7e9b0f7d-098e-1475-6aab-4f73d3200c9a",
"billerId": "a06bb722-88ea-4f91-be1d-03e91531470b",
"dateTimeTimestamp": "2023-10-02T19:28:18.3814312Z",
"documentTypeId": 1,
"series": null,
"actualNumber": 20,
"actualNumberLastUpdate": "2023-10-02T21:35:48.9265254Z",
"actualNumberLastUpdateSource": "System",
"numberFrom": 11,
"numberTo": 20,
"dateTo": null,
"author": "System",
"deleted": false,
"status": 7,
"data": null
},
{
"countryId": "cl",
"accountCode": "{{taxId}}",
"subRangeId": "35ebd4c5-02e1-4edc-a4bf-f5743d478a6a",
"primaryRangeId": "7e9b0f7d-098e-1475-6aab-4f73d3200c9a",
"billerId": "a06bb722-88ea-4f91-be1d-03e91531470b",
"dateTimeTimestamp": "2023-10-04T14:07:38.4801926Z",
"documentTypeId": 1,
"series": null,
"actualNumber": 1000,
"actualNumberLastUpdate": "2023-10-04T14:08:10.4433307Z",
"actualNumberLastUpdateSource": "System",
"numberFrom": 995,
"numberTo": 1000,
"dateTo": null,
"author": "System",
"deleted": false,
"status": 7,
"data": null
}
]

4. SetGlobalFolioManagerAccountThreshold

Method: POST

Este endpoint permite definir tanto el tamaño de recarga (refill) como el umbral de recarga automática (threshold) de los rangos primarios en la configuración del gestor de folios, para cada tipo de documento, a nivel de cuenta.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/SetGlobalFolioManagerAccountThreshold

URL PRD

https://developers.gosocket.net/number-manager-admin/SetGlobalFolioManagerAccountThreshold


Request

{
"countryId": "cl",
"accountCode": "{{taxId}}",
"documentTypeId": 33,
"threshold": 100,
"refill": 1000,
"version": 3,
"accountUser": "user@empresa.com"
}

📝 El valor de threshold debe ser menor que refill; de lo contrario el proceso entra en un bucle de recarga.

Response

{
"code": 200,
"message": "Configuración de umbral para descarga exitoso",
"data": "\"Se procesó correctamente.\"",
"isSuccess": true
}

4.1 GetGlobalFolioManagerAccountThreshold

Method: GET

Este endpoint permite consultar el tamaño de recarga (refill) y el umbral de recarga automática (threshold) configurados a nivel de cuenta para cada tipo de documento en el gestor de folios.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/GetGlobalFolioManagerAccountThreshold

URL PRD

https://developers.gosocket.net/number-manager-admin/GetGlobalFolioManagerAccountThreshold


Request

image-20250725-164448.png

Response

[
{
"countryId": "cl",
"taxId": "{{taxId}}",
"documentTypeId": 33,
"threshold": 100,
"refill": 1000,
"startFrom": 0,
"version": 3,
"prefix": null,
"lastChangeAuthor": "user@empresa.com",
"partitionKey": "AutomaticPrimaryRangeProcess",
"rowKey": "cl|{{taxId}}|33|3",
"timestamp": "2025-07-25T16:42:04.2067296+00:00",
"eTag": "W/\"datetime'2025-07-25T16%3A42%3A04.2067296Z'\""
},
{
"countryId": "cl",
"taxId": "{{taxId}}",
"documentTypeId": 39,
"threshold": 100,
"refill": 500,
"startFrom": 0,
"version": 3,
"prefix": null,
"lastChangeAuthor": "user@empresa.com",
"partitionKey": "AutomaticPrimaryRangeProcess",
"rowKey": "cl|{{taxId}}|39|3",
"timestamp": "2025-04-29T14:45:48.4840042+00:00",
"eTag": "W/\"datetime'2025-04-29T14%3A45%3A48.4840042Z'\""
}
]

4.2 DeleteGlobalFolioManagerAccountThreshold

Method: DELETE

Permite eliminar la configuración de recarga y umbral de los rangos primarios definidos en el gestor de folios de una cuenta, para un tipo de documento específico.

Se requiere enviar los siguientes valores concatenados:
countryId|taxId|documentTypeId|3
Ejemplo: cl|{{taxId}}|33|3


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/DeleteGlobalFolioManagerAccountThreshold

URL PRD

https://developers.gosocket.net/number-manager-admin/DeleteGlobalFolioManagerAccountThreshold


Request

image-20250725-164837.png

Response

{
"code": 200,
"message": "Eliminación de umbral para descarga exitosa",
"data": "\"Se procesó correctamente.\"",
"isSuccess": true
}

5. AnnulmentPrimaryRange

Method: POST

Permite obtener los folios disponibles para anulación dentro del SII, asociados a un rango primario específico.
En la respuesta se indicarán los valores de “Desde” y “Hasta”, que luego se utilizarán para realizar la anulación correspondiente.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/AnnulmentPrimaryRange

URL PRD

https://developers.gosocket.net/number-manager-admin/AnnulmentPrimaryRange


Request

{
"accountCode": "{{taxId}}",
"countryId": "cl",
"primaryRangeId": "afc4ad1d-0a04-47e6-89a1-e07f195771b9",
"author": "user@empresa.com"
}

Response

{
"code": 200,
"message": "Folios disponibles para Anular, Desde:21344 Hasta:21348",
"data": "{\"PrimaryRangeId\":\"afc4ad1d-0a04-47e6-89a1-e07f195771b9\",\"NumberMin\":21344,\"NumberMax\":21348}",
"isSuccess": true
}

5.1 ConfirmAnnulmentPrimaryRange

Method: POST

Este endpoint permite confirmar la anulación de un rango primario ante el SII.
Para construir la solicitud, se deben utilizar los valores entregados previamente por el endpoint 5. AnnulmentPrimaryRange.


URL SBX

https://developers-sbx.gosocket.net/number-manager-admin/ConfirmAnnulmentPrimaryRange

URL PRD

https://developers.gosocket.net/number-manager-admin/ConfirmAnnulmentPrimaryRange


Request

{
"accountCode": "{{taxId}}",
"countryId": "cl",
"primaryRangeId": "afc4ad1d-0a04-47e6-89a1-e07f195771b9",
"author": "user@empresa.com",
"numberFrom": 21344,
"numberTo": 21348
}

Response

{
"code": 200,
"message": "El rango de folios indicado han sido anulado correctamente",
"data": null,
"isSuccess": true
}