Get invoice

GET https://api.ecurring.com/invoices/{id}

Retrieve a single invoice by its identifier.

Parameters

Replace {id} in the URL with the identifier of the invoice.

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

Data attributes

status
string
The status of the invoice. Possible values are draft / open / paid / charged_back / cancelled or completed
reference
string
The unique reference number for this invoice. Prefixed by the invoice prefix set in your account settings.
amount_excl
double
The gross amount of the invoice, excluding the tax_amount
amount_incl
double
The net amount of the invoice, including the tax_amount
tax_amount
double
The tax amount in euro.
invoice_date
datetime
The invoice date. This is the date on which the invoiced was finalised, or will be finalised if this is a future date. In ISO 8601 format.
transaction_date
datetime
The date of the transaction that was, or will be, created for this invoice. In ISO 8601 format.
hosted_invoice_url
string
The URL for the hosted invoice page, which allows customers to view and print an invoice.
send_email
boolean
Indicates whether the invoice will be sent to customer upon finalising. Defaults to `send_invoice` value of the connected subscription plan.
created_at
datetime
The date on which the invoice was created.
updated_at
datetime
The date on which the invoice was last updated

Relationships

subscription
subscription
The subscription which the invoice belongs to
customer
customer
The customer which the invoice belongs to
invoice-lines
invoice-lines
The invoice lines that belong to the invoice
transaction
transaction
The transaction that belongs to the invoice
original-invoice
original-invoice
The invoice the current invoice relates to. This may be the case with a credit invoice

Example

Response

{
    "links": {
        "self": "https://api.ecurring.com/invoices/637377985"
    },
    "data": {
        "type": "invoice",
        "id": "637377985",
        "links": {
            "self": "https://api.ecurring.com/invoices/637377985"
        },
        "attributes": {
            "status": "draft",
            "reference": "DRAFT",
            "amount_excl": "10.00",
            "amount_incl": "12.10",
            "tax_amount": "2.10",
            "invoice_date": "2019-10-10T00:00:00+02:00",
            "transaction_date": "2019-10-10T00:00:00+02:00",
            "hosted_invoice_url": "https://billing.ecurring.com/invoice/fc728385dbbfd387589d837d074fea43?lang=en",
            "send_email": true,
            "created_at": "2019-10-03T11:33:17+02:00",
            "updated_at": "2019-10-03T11:33:17+02:00"
        },
        "relationships": {
            "subscription": {
                "links": {
                    "related": "https://api.ecurring.com/invoices/637377985/subscription"
                },
                "data": {
                    "type": "subscription",
                    "id": "739578262"
                }
            },
            "customer": {
                "links": {
                    "related": "https://api.ecurring.com/invoices/637377985/customer"
                },
                "data": {
                    "type": "customer",
                    "id": "149526343"
                }
            },
            "invoice-lines": {
                "links": {
                    "related": "https://api.ecurring.com/invoices/637377985/lines"
                },
                "data": []
            },
            "transaction": {
                "data": null
            },
            "original-invoice": {
                "data": null
            }
        }
    }
}