GeneralInvoice

Modelo GeneralInvoice

{
    "id": 23,
    "number": 1,
    "status": "conciliated",
    "count": 7,
    "total_e2": 24792,
    "subtotal": "USD 271.56",
    "fee": "USD -23.64",
    "total": "USD 247.92",
    "paid_at": "2022-02-21 19:21:02",
    "notes": null,
    "created_at": "2022-02-21 19:05:18",
    "updated_at": "2025-04-10 16:47:23",
    "discount": "USD 0.00",
    "payment": null,
    "config": {
        "total_e2": 24792,
        "subtotal_e2": 27156,
        "fee_e2": -2364,
        "discount_e2": 0,
        "fiscal_base_e2": 34656
    },
    "total_to_pay_e2": 24792,
    "company_id": 116,
    "payment_ref": null,
    "city_id": 30,
    "is_payment_requested": false,
    "is_payment_sent": false,
    "is_payment_successful": false,
    "is_payment_failed": false,
    "payment_try_count": 0,
    "payment_index": 0,
    "is_invoice_doc_requested": false,
    "is_invoice_doc_sent": false,
    "is_invoice_doc_successful": false,
    "is_invoice_doc_failed": false,
    "is_ignored_for_balance": false,
    "payment_status": "not_available",
    "payment_error": null,
    "fiscal_base_e2": 34656,
    "subtotal_e2": 27156,
    "fee_e2": -2364,
    "branch_subtotal_e2": 27156,
    "discount_e2": 0,
    "delivery_base_e2": 0,
    "delivery_discount_e2": 0,
    "delivery_e2": 0,
    "delivery_fee_e2": 0,
    "breakdown": {
        "fiscal_tax_name": "IVA",
        "fiscal_tax_prc": 0.16,
        "total": {
            "amount_e2": 2675225,
            "currency_iso": "VES",
            "formatted_iso": "VES 26.752,25",
            "formatted": "26.752,25Bs"
        },
        "fiscal_base": {
            "amount_e2": 3414074,
            "currency_iso": "VES",
            "formatted_iso": "VES 34.140,74",
            "formatted": "34.140,74Bs"
        },
        "service_fee": {
            "amount_e2": 200763,
            "currency_iso": "VES",
            "formatted_iso": "VES 2.007,63",
            "formatted": "2.007,63Bs"
        },
        "service_fee_taxes": {
            "amount_e2": 32123,
            "currency_iso": "VES",
            "formatted_iso": "VES 321,23",
            "formatted": "321,23Bs"
        },
        "service_fee_total": {
            "amount_e2": 232886,
            "currency_iso": "VES",
            "formatted_iso": "VES 2.328,86",
            "formatted": "2.328,86Bs"
        },
        "total_to_pay": {
            "amount_e2": 2442340,
            "currency_iso": "VES",
            "formatted_iso": "VES 24.423,40",
            "formatted": "24.423,40Bs"
        },
        "currency_rate": 98.5132
    }
}
Atributo Tipo Descripción
id int -
number int -
status string -
count int -
total_e2 int -
subtotal string -
fee string -
total string -
paid_at string\|null -
created_at datetime\|null -
updated_at datetime\|null -
discount string -
config array -
total_to_pay_e2 int\|null -
company_id int\|null -
city_id int\|null -
delivery_base_e2 int\|null -
delivery_discount_e2 int\|null -
delivery_e2 int\|null -
delivery_fee_e2 int\|null -
discount_e2 int\|null -
fee_e2 int\|null -
fiscal_base_e2 int\|null -
subtotal_e2 int\|null -
is_payment_requested bool BitMask (({@link self::flags} & 0x1) !== 0)
is_payment_sent bool BitMask (({@link self::flags} & 0x2) !== 0)
is_payment_successful bool BitMask (({@link self::flags} & 0x4) !== 0)
is_payment_failed bool BitMask (({@link self::flags} & 0x8) !== 0)
payment_try_count int BitMask (({@link self::flags} & 0xf0) >> 4)
payment_index int BitMask (({@link self::flags} & 0xf00) >> 8)
is_invoice_doc_requested bool BitMask (({@link self::flags} & 0x1000) !== 0)
is_invoice_doc_sent bool BitMask (({@link self::flags} & 0x2000) !== 0)
is_invoice_doc_successful bool BitMask (({@link self::flags} & 0x4000) !== 0)
is_invoice_doc_failed bool BitMask (({@link self::flags} & 0x8000) !== 0)
is_ignored_for_balance bool BitMask (({@link self::flags} & 0x10000) !== 0)
branch_subtotal_e2 int\|null -
breakdown array\|null -
payment_status string -

Insertar GeneralInvoice

Método URI Cabeceras
POST /companies/{companyId}/{relatedType}/{relatedId}/general-invoices Authorization 
{
    "notes": "nullable|string",
    "order_ids": [
        "integer"
    ],
    "related_type": "string|in:providers,branches,accounts",
    "currency_conversion_factor": "nullable|numeric|min:0.000001"
}

Listar GeneralInvoice

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/{relatedType}/{relatedId}/general-invoices Authorization

Listar GeneralInvoice de Company

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/{relatedType}/{relatedId}/general-invoices Authorization

Mostrar GeneralInvoice

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/general-invoices/{generalInvoiceId} Authorization

Eliminar GeneralInvoice

Método URI Cabeceras
DELETE /companies/{companyId}/general-invoices/{generalInvoiceId} Authorization

Acciones de GeneralInvoice

Store Batch

Método URI Cabeceras
POST /companies/{companyId}/general-invoices Authorization 
{
    "notes": "nullable|string",
    "order_ids": [
        "integer"
    ],
    "related_type": "string|in:providers,branches,accounts",
    "currency_conversion_factor": "nullable|numeric|min:0.000001"
}

View

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/general-invoices/batch-send-payments Authorization 
{
    "type": "required|string|in:providers,branches,accounts",
    "mode": "required|string|in:pending,conciliated,failed,ids",
    "ids": [
        "integer|min:1"
    ],
    "date_beg": "date",
    "date_end": "date"
}

Perform

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
POST /companies/{companyId}/general-invoices/batch-send-payments Authorization 
{
    "type": "required|string|in:providers,branches,accounts",
    "mode": "required|string|in:pending,conciliated,failed,ids",
    "ids": [
        "integer|min:1"
    ],
    "date_beg": "date",
    "date_end": "date"
}

Perform

{info} Soporta: Paginación Filters Carga dinámica

Realiza la concilicación de la factura (irreversible).

Una vez conciliada una factura, ésta no puede ser modificada. Si se envía el parámetro send_payment = true, entonces se realizará un pago automatizado a los datos registrados del comercio o repartidor.

Método URI Cabeceras
POST /companies/{companyId}/general-invoices/{generalInvoiceId}/conciliate Authorization

Perform

{info} Soporta: Paginación Filters Carga dinámica

Envía una solicitud de pago automatizado para la factura.

Para usar este endpoint, la orden debe estar en status = conciliated y el payment_status debe ser not_available o failed.

El atributo payment_status revela información del estado actual de la solicitud de pago. Los valores posibles son:

  • not_available: Indica que no se ha solicitado un pago.
  • requested: La solicitud de pago ha sido enviada, pero aún no ha sido procesada por el sistema.
  • sent: La solicitud de pago ha sido procesada y enviada. En espera de confirmación.
  • failed: El pago ha fallado. La solicitud de pago ha terminado con un error.
  • successful: El pago ha sido procesado con éxito.

Errores posibles

Método URI Cabeceras
POST /companies/{companyId}/general-invoices/{generalInvoiceId}/send-payment Authorization

Perform

{info} Soporta: Paginación Filters Carga dinámica

Marca como pagada a una factura manualmente.

Útil para que el sistema marque las facturas como pagadas cuando el API externo responde con algun error.

Método URI Cabeceras
POST /companies/{companyId}/general-invoices/{generalInvoiceId}/set-paid Authorization

Batch Destroy

Método URI Cabeceras
DELETE /companies/{companyId}/general-invoices/batch-delete Authorization 
[
    "integer"
]

Enlaces de GeneralInvoice