GET /open_api/v1/accounting
Accounting lines

All accounting lines, paginated (necessarily becauce there is a lot of data) with optional dates filtering. Ordered by date descendant.
The field status indicates if the accounting data is being built or if the build is over. Possible status are: building or built.
The field invoice.payment_details is available if line_type=payment. It will contain the following data:
· payment_mean, possible status are: card, wallet or other. WARNING: If an invoice was settled using multiple payment means, this will only report the payment mean applicable to current line.
· gateway_object_id, if payment_mean=card, report the ID of the payment gateway related object
· gateway_object_type, if payment_mean=card, report the type of the payment gateway related object
· wallet_transaction_id, if payment_mean=wallet, report the ID of the wallet transaction

Supported Formats

json

Examples

# /open_api/v1/accounting?after=2022-01-01T00:00:00+02:00&page=1&per_page=3
{
  "lines": [
    {
      "id": 1,
      "line_type": "payment",
      "journal_code": "VT01",
      "date": "2022-01-02T18:14:21+01:00",
      "account_code": "5802",
      "account_label": "Card customers",
      "analytical_code": "",
      "invoice": {
        "reference": "22010009/VL",
        "id": 274,
        "label": "Subscription of Dupont Marcel for 1 month starting from 2022, january 2nd",
        "url": "/open_api/v1/invoices/247/download",
        "payment_details": {
          "payment_mean": "card",
          "gateway_object_id": "pi_3MA2PPW4kx8QemzC02ABBEbo",
          "gateway_object_type": "Stripe::PaymentIntent"
        }
      },
      "user": {
        "invoicing_profile_id": 6512,
        "external_id": "U52-ALC4"
      },
      "debit": 14.0,
      "credit": 0
      "currency": "EUR",
      "summary": "Dupont Marcel, 22010009/VL, subscr."
    },
    {
      "id": 2,
      "line_type": "item",
      "journal_code": "VT01",
      "date": "2022-01-02T18:14:21+01:00",
      "account_code": "7071",
      "account_label": "Subscriptions",
      "analytical_code": "P3D71",
      "invoice": {
        "reference": "22010009/VL",
        "id": 274,
        "label": "Subscription of Dupont Marcel for 1 month starting from 2022, january 2nd",
        "url": "/open_api/v1/invoices/247/download"
      },
      "user_invoicing_profile_id": 6512,
      "debit": 0,
      "credit": 11.67
      "currency": "EUR",
      "summary": "Dupont Marcel, 22010009/VL, subscr."
    },
    {
      "id": 3,
      "line_type": "vat",
      "journal_code": "VT01",
      "date": "2022-01-02T18:14:21+01:00",
      "account_code": "4457",
      "account_label": "Collected VAT",
      "analytical_code": "P3D71",
      "invoice": {
        "reference": "22010009/VL",
        "id": 274,
        "label": "Subscription of Dupont Marcel for 1 month starting from 2022, january 2nd",
        "url": "/open_api/v1/invoices/247/download"
      },
      "user_invoicing_profile_id": 6512,
      "debit": 0,
      "credit": 2.33
      "currency": "EUR",
      "summary": "Dupont Marcel, 22010009/VL, subscr."
    }
  ],
  "status": "built"
}

Params

Param name	Description
page optional	Page number Validations: Must be a Integer
per_page optional	Number of objects per page. Default is 20. Validations: Must be a Integer
after optional	Filter accounting lines to lines after the given date. Validations: Must be a DateTime
before optional	Filter accounting lines to lines before the given date. Validations: Must be a DateTime
invoice_id optional	Scope the request to one or various invoices. Validations: Must be one of: Integer, Array.
type optional	Filter accounting lines by line type. Validations: Must be one of: client, vat, item.