Skip to content

Commit 0ad5799

Browse files
raul-facturapiraul-facturapi
authored
Chore/hidrocarburospetroliferos docs (#253)
* chore(hyp): add new complement item * chore(catalogs): add constants for hyp catalogs
1 parent c96d8d4 commit 0ad5799

2 files changed

Lines changed: 254 additions & 12 deletions

File tree

‎website/openapi_v2.en.yaml‎

Lines changed: 128 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,42 @@ tags:
130130
"CP01" | Pagos | Payments | 601, 603, 605, 606, 608, 610, 611, 612, 614, 616, 620, 621, 622, 623, 624, 607, 615, 625, 626
131131
"CN01" | Nómina | Payroll | 605
132132

133+
### Catálogos Hidrocarburos Petrolíferos
134+
135+
(Hydrocarbons and Petroleum Catalogs)
136+
137+
Permit key | Description (Spanish) | Description (English)
138+
:-----:|:-----------|:-----------
139+
"PER01" | Expendio en estaciones de servicio de petrolíferos | Fuel station retail sales
140+
"PER02" | Comercialización | Commercialization
141+
"PER03" | Distribución por otros medios distintos a ducto | Distribution by means other than pipeline
142+
"PER04" | Expendio en estaciones de servicio multimodal de petrolíferos | Multimodal fuel station retail sales
143+
"PER05" | Expendio en estaciones de servicio de petrolíferos | Fuel station retail sales
144+
"PER06" | Comercialización | Commercialization
145+
"PER07" | Distribución por otros medios distintos a ducto | Distribution by means other than pipeline
146+
"PER08" | Expendio en estaciones de servicio multimodal de petrolíferos | Multimodal fuel station retail sales
147+
"PER09" | Comercialización | Commercialization
148+
"PER10" | Comercialización | Commercialization
149+
"PER11" | Comercialización | Commercialization
150+
151+
HYP key | Description (Spanish) | Description (English)
152+
:-----:|:-----------|:-----------
153+
"15101514" | Gasolina | Gasoline
154+
"15101515" | Diesel | Diesel
155+
"15101505" | Combustibles para barco | Marine fuels
156+
157+
Subproduct HYP | Description (Spanish) | Description (English)
158+
:-----:|:-----------|:-----------
159+
"SP16" | Gasolina regular menor a 91 octanos | Regular gasoline under 91 octane
160+
"SP17" | Gasolina premium mayor o igual a 91 octanos | Premium gasoline 91 octane or higher
161+
"SP18" | Diésel automotriz | Automotive diesel
162+
"SP19" | Diésel marino | Marine diesel
163+
"SP22" | IFO380 | IFO380
164+
"SP23" | Diésel industrial | Industrial diesel
165+
"SP24" | Diésel de Ultra Bajo Azufre (DUBA) | Ultra low sulfur diesel (ULSD)
166+
"SP25" | Diésel agrícola | Agricultural diesel
167+
"SP48" | Gasóleo doméstico | Domestic gas oil
168+
133169
### Relación entre facturas
134170

135171
(Relation between invoices)
@@ -11167,9 +11203,12 @@ components:
1116711203
type: string
1116811204
description: Customs entry numbers (pedimento) associated with this concept.
1116911205
complement:
11170-
type: string
11171-
format: xml
11172-
description: XML code of your concept-level complement.
11206+
description: XML code of your concept-level complement or the Hydrocarbons and Petroleum complement.
11207+
oneOf:
11208+
- type: string
11209+
format: xml
11210+
description: XML code of your concept-level complement.
11211+
- $ref: "#/components/schemas/HidroYPetroComplementInput"
1117311212
third_party:
1117411213
allOf:
1117511214
- type: object
@@ -11217,9 +11256,12 @@ components:
1121711256
type: string
1121811257
description: Customs entry numbers (pedimento) associated with this concept.
1121911258
complement:
11220-
type: string
11221-
format: xml
11222-
description: XML code of your concept-level complement.
11259+
description: XML code of your concept-level complement or the Hydrocarbons and Petroleum complement.
11260+
oneOf:
11261+
- type: string
11262+
format: xml
11263+
description: XML code of your concept-level complement.
11264+
- $ref: "#/components/schemas/HidroYPetroComplementInput"
1122311265
third_party:
1122411266
allOf:
1122511267
- type: object
@@ -11287,6 +11329,86 @@ components:
1128711329
type: string
1128811330
description: Postal code of the third party.
1128911331
example: "01234"
11332+
HidroYPetroComplementInput:
11333+
title: HidroYPetroComplement
11334+
type: object
11335+
required:
11336+
- tipo_permiso
11337+
- numero_permiso
11338+
- sub_producto_hyp
11339+
properties:
11340+
tipo_permiso:
11341+
type: string
11342+
enum:
11343+
- PER01
11344+
- PER02
11345+
- PER03
11346+
- PER04
11347+
- PER05
11348+
- PER06
11349+
- PER07
11350+
- PER08
11351+
- PER09
11352+
- PER10
11353+
- PER11
11354+
example: PER01
11355+
description: Type of permit granted by the competent authority, according to the [Hydrocarbons and Petroleum Catalogs](#cat%C3%A1logos-hidrocarburos-petrol%C3%ADferos).
11356+
x-enum-descriptions:
11357+
- Expendio en estaciones de servicio de petroliferos
11358+
- Comercializacion
11359+
- Distribucion por otros medios distintos a ducto
11360+
- Expendio en estaciones de servicio multimodal de petroliferos
11361+
- Expendio en estaciones de servicio de petroliferos
11362+
- Comercializacion
11363+
- Distribucion por otros medios distintos a ducto
11364+
- Expendio en estaciones de servicio multimodal de petroliferos
11365+
- Comercializacion
11366+
- Comercializacion
11367+
- Comercializacion
11368+
numero_permiso:
11369+
type: string
11370+
minLength: 15
11371+
maxLength: 35
11372+
description: Permit number granted by the competent authority, according to the c_TipoPermiso catalog nomenclature.
11373+
sub_producto_hyp:
11374+
type: string
11375+
enum:
11376+
- SP16
11377+
- SP17
11378+
- SP18
11379+
- SP19
11380+
- SP22
11381+
- SP23
11382+
- SP24
11383+
- SP25
11384+
- SP48
11385+
example: SP16
11386+
description: Hydrocarbon or petroleum subproduct, according to the [Hydrocarbons and Petroleum Catalogs](#cat%C3%A1logos-hidrocarburos-petrol%C3%ADferos).
11387+
x-enum-descriptions:
11388+
- Gasolina regular menor a 91 octanos
11389+
- Gasolina premium mayor o igual a 91 octanos
11390+
- Diésel automotriz
11391+
- Diésel marino
11392+
- IFO380
11393+
- Diésel industrial
11394+
- Diésel de Ultra Bajo Azufre (DUBA)
11395+
- Diésel agrícola
11396+
- Gasóleo doméstico
11397+
clave_hyp:
11398+
type: string
11399+
enum:
11400+
- "15101514"
11401+
- "15101515"
11402+
- "15101505"
11403+
example: "15101514"
11404+
description: |
11405+
Hydrocarbon and petroleum key, according to the [Hydrocarbons and Petroleum Catalogs](#cat%C3%A1logos-hidrocarburos-petrol%C3%ADferos).
11406+
11407+
You can send it explicitly or let Facturapi derive it from the concept's `product_key` when applicable.
11408+
x-enum-descriptions:
11409+
- Gasolina
11410+
- Diesel
11411+
- Combustibles para barco
1129011412

1129111413
CustomComplementData:
1129211414
title: string

‎website/openapi_v2.yaml‎

Lines changed: 126 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,40 @@ tags:
135135
"CP01" | Pagos | 601, 603, 605, 606, 608, 610, 611, 612, 614, 616, 620, 621, 622, 623, 624, 607, 615, 625, 626
136136
"CN01" | Nómina | 605
137137

138+
### Catálogos Hidrocarburos Petrolíferos
139+
140+
Clave de permiso | Descripción
141+
:-----:| -----------
142+
"PER01" | Expendio en estaciones de servicio de petrolíferos
143+
"PER02" | Comercialización
144+
"PER03" | Distribución por otros medios distintos a ducto
145+
"PER04" | Expendio en estaciones de servicio multimodal de petrolíferos
146+
"PER05" | Expendio en estaciones de servicio de petrolíferos
147+
"PER06" | Comercialización
148+
"PER07" | Distribución por otros medios distintos a ducto
149+
"PER08" | Expendio en estaciones de servicio multimodal de petrolíferos
150+
"PER09" | Comercialización
151+
"PER10" | Comercialización
152+
"PER11" | Comercialización
153+
154+
Clave HYP | Descripción
155+
:-----:| -----------
156+
"15101514" | Gasolina
157+
"15101515" | Diesel
158+
"15101505" | Combustibles para barco
159+
160+
Subproducto HYP | Descripción
161+
:-----:| -----------
162+
"SP16" | Gasolina regular menor a 91 octanos
163+
"SP17" | Gasolina premium mayor o igual a 91 octanos
164+
"SP18" | Diésel automotriz
165+
"SP19" | Diésel marino
166+
"SP22" | IFO380
167+
"SP23" | Diésel industrial
168+
"SP24" | Diésel de Ultra Bajo Azufre (DUBA)
169+
"SP25" | Diésel agrícola
170+
"SP48" | Gasóleo doméstico
171+
138172
### Relación entre facturas
139173

140174
Clave | Descripción
@@ -11365,9 +11399,12 @@ components:
1136511399
type: string
1136611400
description: Números de pedimento asociados a este concepto.
1136711401
complement:
11368-
type: string
11369-
format: xml
11370-
description: Código XML de tu complemento concepto.
11402+
description: Código XML de tu complemento concepto o el complemento Hidrocarburos y Petrolíferos.
11403+
oneOf:
11404+
- type: string
11405+
format: xml
11406+
description: Código XML de tu complemento concepto.
11407+
- $ref: "#/components/schemas/HidroYPetroComplementInput"
1137111408
third_party:
1137211409
allOf:
1137311410
- type: object
@@ -11415,9 +11452,12 @@ components:
1141511452
type: string
1141611453
description: Números de pedimento asociados a este concepto.
1141711454
complement:
11418-
type: string
11419-
format: xml
11420-
description: Código XML de tu complemento concepto.
11455+
description: Código XML de tu complemento concepto o el complemento Hidrocarburos y Petrolíferos.
11456+
oneOf:
11457+
- type: string
11458+
format: xml
11459+
description: Código XML de tu complemento concepto.
11460+
- $ref: "#/components/schemas/HidroYPetroComplementInput"
1142111461
third_party:
1142211462
allOf:
1142311463
- type: object
@@ -11485,6 +11525,86 @@ components:
1148511525
type: string
1148611526
description: Código postal del tercero.
1148711527
example: "01234"
11528+
HidroYPetroComplementInput:
11529+
title: HidroYPetroComplement
11530+
type: object
11531+
required:
11532+
- tipo_permiso
11533+
- numero_permiso
11534+
- sub_producto_hyp
11535+
properties:
11536+
tipo_permiso:
11537+
type: string
11538+
enum:
11539+
- PER01
11540+
- PER02
11541+
- PER03
11542+
- PER04
11543+
- PER05
11544+
- PER06
11545+
- PER07
11546+
- PER08
11547+
- PER09
11548+
- PER10
11549+
- PER11
11550+
example: PER01
11551+
description: Tipo de permiso otorgado por la autoridad competente, conforme al [Catálogo Hidrocarburos Petrolíferos](#cat%C3%A1logos-hidrocarburos-petrol%C3%ADferos).
11552+
x-enum-descriptions:
11553+
- Expendio en estaciones de servicio de petroliferos
11554+
- Comercializacion
11555+
- Distribucion por otros medios distintos a ducto
11556+
- Expendio en estaciones de servicio multimodal de petroliferos
11557+
- Expendio en estaciones de servicio de petroliferos
11558+
- Comercializacion
11559+
- Distribucion por otros medios distintos a ducto
11560+
- Expendio en estaciones de servicio multimodal de petroliferos
11561+
- Comercializacion
11562+
- Comercializacion
11563+
- Comercializacion
11564+
numero_permiso:
11565+
type: string
11566+
minLength: 15
11567+
maxLength: 35
11568+
description: Número de permiso otorgado por la autoridad competente, conforme a la nomenclatura del catálogo c_TipoPermiso.
11569+
sub_producto_hyp:
11570+
type: string
11571+
enum:
11572+
- SP16
11573+
- SP17
11574+
- SP18
11575+
- SP19
11576+
- SP22
11577+
- SP23
11578+
- SP24
11579+
- SP25
11580+
- SP48
11581+
example: SP16
11582+
description: Subtipo del hidrocarburo o petrolífero, conforme al [Catálogo Hidrocarburos Petrolíferos](#cat%C3%A1logos-hidrocarburos-petrol%C3%ADferos).
11583+
x-enum-descriptions:
11584+
- Gasolina regular menor a 91 octanos
11585+
- Gasolina premium mayor o igual a 91 octanos
11586+
- Diésel automotriz
11587+
- Diésel marino
11588+
- IFO380
11589+
- Diésel industrial
11590+
- Diésel de Ultra Bajo Azufre (DUBA)
11591+
- Diésel agrícola
11592+
- Gasóleo doméstico
11593+
clave_hyp:
11594+
type: string
11595+
enum:
11596+
- "15101514"
11597+
- "15101515"
11598+
- "15101505"
11599+
example: "15101514"
11600+
description: |
11601+
Clave correspondiente a hidrocarburos y petrolíferos, conforme al [Catálogo Hidrocarburos Petrolíferos](#cat%C3%A1logos-hidrocarburos-petrol%C3%ADferos).
11602+
11603+
Puedes enviarla explícitamente o dejar que Facturapi la derive desde el `product_key` del concepto cuando aplique.
11604+
x-enum-descriptions:
11605+
- Gasolina
11606+
- Diesel
11607+
- Combustibles para barco
1148811608

1148911609
CustomComplementData:
1149011610
title: string

0 commit comments

Comments
 (0)