Issued Documents

List Issued Documents

Changed on

Lists the issued documents.

get/c/{company_id}/issued_documents

Request

  • Base URL: https://api-v2.fattureincloud.it
  • URL: https://api-v2.fattureincloud.it/c/{company_id}/issued_documents
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api-v2.fattureincloud.it/oauth/authorize, token URL https://api-v2.fattureincloud.it/oauth/token, scopes: issued_documents.invoices:r, issued_documents.credit_notes:r, issued_documents.receipts:r, issued_documents.orders:r, issued_documents.quotes:r, issued_documents.proformas:r, issued_documents.delivery_notes:r)
    • HTTP bearer

Query parameters

type'invoice' | 'quote' | 'proforma' | 'receipt' | 'delivery_note' | 'credit_note' | 'order' | 'work_report' | 'supplier_order' | 'self_own_invoice' | 'self_supplier_invoice' required

The type of the issued document.

fieldsstring

List of comma-separated fields.

fieldset'basic' | 'detailed'

Name of the fieldset.

sortstring

List of comma-separated fields for result sorting (minus for desc sorting).

pageinteger

The page to retrieve.

per_pageinteger

The size of the page.

qstring

Query for filtering the results.

inclusive0 | 1

(Only for type = delivery_notes) Include invoices delivery notes.

Response

Results list.

current_pageinteger nullable

Current page number.

first_page_urlstring uri nullable

First page url.

frominteger nullable

First result of the page.

last_pageinteger nullable

Last page number.

last_page_urlstring uri nullable

Last page url.

next_page_urlstring uri nullable

Next page url

pathstring uri nullable

Request path.

per_pageinteger nullable

Number of result per page.

prev_page_urlstring uri nullable

Previous page url.

tointeger nullable

Last result of the page.

totalinteger nullable

Total number of results

Example response

{
  "data": [
    {
      "entity": {
        "code": "123",
        "name": "Rossi S.r.l.",
        "vat_number": "IT01234567890",
        "tax_code": "RSSMRA44A12E890Q",
        "address_street": "Via dei tigli, 12",
        "address_postal_code": "24010",
        "address_city": "Bergamo",
        "address_province": "BG",
        "country": "Italia",
        "country_iso": "Italia",
        "email": "mario.rossi@example.it",
        "certified_email": "mario.rossi@pec.example.it",
        "default_payment_terms": 30,
        "default_vat": {
          "value": 22,
          "description": "Non imponibile art. 123",
          "notes": "IVA non imponibile ai sensi dell'articolo 123, comma 2"
        },
        "default_payment_method": {
          "default_payment_account": {
            "name": "Conto Banca Intesa"
          }
        }
      },
      "number": 1,
      "numeration": "/A",
      "currency": {
        "id": "EUR",
        "symbol": "€",
        "exchange_rate": "1",
        "html_symbol": "EUR"
      },
      "payment_method": {
        "default_payment_account": {
          "name": "Conto Banca Intesa"
        }
      },
      "items_list": [
        {
          "product_id": 1234,
          "code": "239874892374982",
          "name": "Water bottle",
          "net_price": 1.23,
          "gross_price": 1.45,
          "vat": {
            "value": 22,
            "description": "Non imponibile art. 123",
            "notes": "IVA non imponibile ai sensi dell'articolo 123, comma 2"
          }
        }
      ],
      "payments_list": [
        {
          "due_date": "2018-04-03",
          "amount": 1.45,
          "payment_account": {
            "name": "Conto Banca Intesa"
          },
          "paid_date": "2018-04-03"
        }
      ],
      "template": {
        "id": 123,
        "name": "Light Smoke"
      },
      "delivery_note_template": {
        "id": 123,
        "name": "Light Smoke"
      },
      "acc_inv_template": {
        "id": 123,
        "name": "Light Smoke"
      }
    }
  ]
}

Changes

  • 1e05e431cbe1Revision changes
    • warning

      removed the optional property //// from the response with the status

    • info

      the response's property default value ordine was removed for the status