Algebraix logo
Powered by Redocly

Datos de facturación

Obtener datos de facturación

Obtener la información referente a datos de facturacion del estudiante

Request
path Parameters
student_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del padre de familia

Example: ASWDERF4
header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/students/{student_id}/fields/billings
Request samples 
Response samples 
application/json
[
  • {
    }
]
Agregar datos facturación
Agregar datos de facturación


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del padre de familia


 
 Example:  ASWDERF4
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
alias
required
string  [ 1 .. 128 ] characters 
Nombre del alias


 
name
required
string  [ 1 .. 128 ] characters 
Razón social


 
rfc
required
string (rfc)   = 13 characters ^[A-ZÑ&]{3,4}[0-9]{2}[0-1][0-9][0-3][0-9][A-Z...
RFC para la facturación


 
is_preferred
boolean
Son los datos de facturación preferidos


 
address_line_1
string  [ 1 .. 512 ] characters 
Primera parte de la dirección


 
address_line_2
string  [ 1 .. 512 ] characters 
Segunda parte de la dirección


 
exterior_number
string  [ 1 .. 64 ] characters 
Número exterior


 
interior_number
string  [ 1 .. 64 ] characters 
Número interior


 
city
string  [ 1 .. 128 ] characters 
Ciudad


 
country
string  [ 1 .. 128 ] characters 
Pais


 
county
string  [ 1 .. 128 ] characters 
Municipio


 
state
string (state) 
Estado


 Enum: "AGUASCALIENTES" "BAJA CALIFORNIA" "BAJA CALIFORNIA SUR" "CAMPECHE" "CIUDAD DE MEXICO" "CHIAPAS" "CHIHUAHUA" "COAHUILA" "COLIMA" "DURANGO" "GUANAJUATO" "GUERRERO" "HIDALGO" "JALISCO" "MEXICO" "MICHOACAN" "MORELOS" "NAYARIT" "NUEVO LEON" "OAXACA" "PUEBLA" "QUERETARO" "QUINTANA ROO" "SAN LUIS POTOSI" "SINALOA" "SONORA" "TABASCO" "TAMAULIPAS" "TLAXCALA" "VERACRUZ" "YUCATAN" "ZACATECAS"  
zipcode
required
integer
Código Postal


 
telephone
string  [ 1 .. 32 ] characters 
Número de teléfono


 
regime
required
string  non-empty 
Código régimen fiscal


 
invoice_usage
required
string  non-empty 
Código uso CFDI


 
payment_method_digits
string  [ 1 .. 4 ] characters 
Dígitos de forma de pago


 
has_send_by_email
boolean
Tiene habilitada la opcion "envío de facturas por correo"


 
email
required
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
Correo electrónico


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/students/{student_id}/fields/billings
Request samples 
application/json
{
  • "alias": "datos-factura",
  • "name": "ESTUDIANTE01 APELLIDO01",
  • "rfc": "XAXX010101000",
  • "is_preferred": true,
  • "has_send_by_email": true,
  • "address_line_1": "Calle1",
  • "address_line_2": "zona1",
  • "city": "ciudad1",
  • "country": "MEXICO",
  • "county": "municipio1",
  • "state": "SONORA",
  • "zipcode": 83280,
  • "telephone": "1234567891",
  • "regime": "605",
  • "invoice_usage": "D10"
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Billing info added"
}
Actualizar datos facturación
Actualizar datos de facturación


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del Estudiante


 
 Example:  ASWDERF4
billing_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del de la información de facturación


 
 Example:  L2GK6KK4
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
alias
string  [ 1 .. 128 ] characters 
Nombre del alias


 
name
string  [ 1 .. 128 ] characters 
Razón social


 
rfc
string (rfc)   = 13 characters ^[A-ZÑ&]{3,4}[0-9]{2}[0-1][0-9][0-3][0-9][A-Z...
RFC para la facturación


 
is_preferred
boolean
Son los datos de facturación preferidos


 
address_line_1
string  [ 1 .. 512 ] characters 
Primera parte de la dirección


 
address_line_2
string  [ 1 .. 512 ] characters 
Segunda parte de la dirección


 
exterior_number
string  [ 1 .. 64 ] characters 
Número exterior


 
interior_number
string  [ 1 .. 64 ] characters 
Número interior


 
city
string  [ 1 .. 128 ] characters 
Ciudad


 
country
string  [ 1 .. 128 ] characters 
Pais


 
county
string  [ 1 .. 128 ] characters 
Municipio


 
state
string (state) 
Estado


 Enum: "AGUASCALIENTES" "BAJA CALIFORNIA" "BAJA CALIFORNIA SUR" "CAMPECHE" "CIUDAD DE MEXICO" "CHIAPAS" "CHIHUAHUA" "COAHUILA" "COLIMA" "DURANGO" "GUANAJUATO" "GUERRERO" "HIDALGO" "JALISCO" "MEXICO" "MICHOACAN" "MORELOS" "NAYARIT" "NUEVO LEON" "OAXACA" "PUEBLA" "QUERETARO" "QUINTANA ROO" "SAN LUIS POTOSI" "SINALOA" "SONORA" "TABASCO" "TAMAULIPAS" "TLAXCALA" "VERACRUZ" "YUCATAN" "ZACATECAS"  
zipcode
integer
Código Postal


 
telephone
string  [ 1 .. 32 ] characters 
Número de teléfono


 
regime
string  non-empty 
Código régimen fiscal


 
invoice_usage
string  non-empty 
Código uso CFDI


 
payment_method_digits
string  [ 1 .. 4 ] characters 
Dígitos de forma de pago


 
has_send_by_email
boolean
Tiene habilitada la opcion "envío de facturas por correo"


 
email
required
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
Correo electrónico


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


patch/students/{student_id}/fields/billings/{billing_id}
Request samples 
application/json
{
  • "alias": "datos-factura",
  • "name": "STUDENT01 APELLIDO01",
  • "rfc": "XAXX010101000",
  • "is_preferred": true,
  • "address_line_1": "Calle1",
  • "address_line_2": "zona1",
  • "city": "ciudad1",
  • "country": "MEXICO",
  • "county": "municipio1",
  • "state": "SONORA",
  • "zipcode": 83280,
  • "telephone": "1234567891",
  • "regime": "605",
  • "has_send_by_email": true,
  • "email": "pabloperez@yahoo.com",
  • "invoice_usage": "D10"
}
Response samples 
application/json
{
  • "details": [
    ],
  • "message": "string"
}
Eliminar datos facturación
Eliminar datos de facturación


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del Estudiante


 
 Example:  ASWDERF4
billing_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del de la información de facturación


 
 Example:  L2GK6KK4
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


delete/students/{student_id}/fields/billings/{billing_id}
Request samples 
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Billing info deleted"
}
➔ Next to Padres de familia