Search sat catalog
title: Search the SAT catalogs¶
Looks up SAT catalog keys (ClaveProdServ, ClaveUnidad) by key or by text; the results are valid keys for a concept.
Alcance (scope): invoices:read · Características: Solo lectura, Idempotente
Parámetros¶
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
catalog |
string | Sí | |
key |
string | No | Exact key lookup: returns the entry or an empty list. |
query |
string | No | Text matched (case- and accent-insensitive) against the description and as a key prefix. Either key or query is given. |
limit |
integer | No | |
issuer |
string | Sí | Id of the issuer the call acts for, from list_issuers. |
Esquema de entrada (JSON Schema)¶
{
"type": "object",
"properties": {
"catalog": {
"type": "string",
"enum": [
"clave_prod_serv",
"clave_unidad"
]
},
"key": {
"type": "string",
"description": "Exact key lookup: returns the entry or an empty list."
},
"query": {
"type": "string",
"description": "Text matched (case- and accent-insensitive) against the description and as a key prefix. Either key or query is given."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 20
},
"issuer": {
"type": "string",
"format": "uuid",
"description": "Id of the issuer the call acts for, from list_issuers."
}
},
"required": [
"catalog",
"issuer"
]
}