Developers
Ingresar a la plataforma

Listar cuentas contables

GET/api/public/v1/account-types

Devuelve una página de cuentas contables de la empresa en formato HAL. Admite filtros por companyCode, text, name, includeUnselectable e include, y paginado.

Autorización

apiKeyScheme
X-API-KEY<token>

En: header

Parámetros de consulta

page?integer

Número de página a devolver, comenzando en 0.

Formatoint32
size?integer

Cantidad de elementos por página.

Formatoint32
sort?array<>

Criterios de ordenamiento del resultado. Actualmente se ignora: el resultado se ordena siempre por nombre, de forma ascendente.

Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.

property?string
direction?string

Valor en

  • "ASC"
  • "DESC"
companyCode*string

Código de la empresa cuyas cuentas contables se desean listar. Si la api-key no tiene acceso a esa empresa, el resultado es vacío.

Longitud1 <= length
text?string

Texto libre para buscar por nombre o número de cuenta contable.

name?string

Filtra por nombre exacto de la cuenta contable.

includeUnselectable?boolean

Indica si se deben incluir cuentas contables no seleccionables en el resultado.

include?array<string>

uniqueCodes de cuentas contables: limita el resultado a esas cuentas contables.

Cuerpo de la respuesta

application/vnd.hal+json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/account-types?companyCode=0590843e-1d92-4d51-82c6-4a22a6b8be82"
{  "_embedded": {    "accountTypes": [      {        "uniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82",        "companyCode": "string",        "number": "string",        "name": "Viáticos",        "selectable": true      }    ]  },  "_links": {    "property1": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    },    "property2": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    }  },  "page": {    "size": 0,    "totalElements": 0,    "totalPages": 0,    "number": 0  }}