Invoices

List invoices

List invoices

Returns all your current invoices in a list.

Example

$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --request GET \
       https://api.checkdomain.de/v1/invoices

Response

{
    "page": 1,
    "limit": 10,
    "pages": 1,
    "total": 2,
    "_links": {
        "self": {
            "href": "/v1/invoices?page=1&limit=10"
        },
        "first": {
            "href": "/v1/invoices?page=1&limit=10"
        },
        "last": {
            "href": "/v1/invoices?page=13&limit=10"
        },
        "next": {
            "href": "/v1/invoices?page=2&limit=10"
        }
    },
    "_embedded": {
        "invoices": [
            {
                "id": 1,
                "invoice_number": "1111-100001",
                "created": "2017-11-16T10:07:15+0100",
                "amount_total": 12,
                "amount_payed": 10.02,
                "amount_open": 1.98,
                "is_open": true,
                "is_payed": false,
                "_links": {
                    "self": {
                        "href": "/v1/invoices/1"
                    }
                }
            },
            {
                "id": 2,
                "invoice_number": "2222-200002",
                "created": "2017-10-09T08:32:46+0100",
                "amount_total": 24.68,
                "amount_payed": 24.68,
                "amount_open": 0,
                "is_open": false,
                "is_payed": true,
                "_links": {
                    "self": {
                        "href": "/v1/invoices/2"
                    }
                }
            },
        ]
    }
}

Filters

Name	Type	Required	Description
query	string		Invoice number
page	integer		Page number
limit	integer		Items per page

Response

Name	Type	Required	Description
root Show properties	collection	Yes	array of objects (Invoice)
Properties of Invoice Name Type Required Description id integer Identifier invoice_number string Invoice number created DateTime Date created amount_total float Total amount to pay amount_open float Total amount still open amount_payed float Total amount payed is_open boolean Flag whether this invoice is not fully payed is_payed boolean Flag whether this invoice is fully payed

Status-Codes

Code	Description
200	Ok

Get an invoice

Get an invoice

Retrieves a single invoice by identifier.

Example

$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --request GET \
       https://api.checkdomain.de/v1/invoices/{invoice}

Response

{
    "id": 1,
    "invoice_number": "1111-100001",
    "created": "2017-11-16T09:40:24+0100",
    "amount_total": 12,
    "amount_payed": 10.02,
    "amount_open": 1.98,
    "is_open": true,
    "is_payed": false,
    "tax": 19,
    "details": [
        {
            "quantity": 1,
            "unit_price": 12,
            "price": 12,
            "remark": "api.checkdomain.de / 17.11.2017 - 16.11.2018"
        }
    ],
    "payments": [
        {
            "amount": 10.02,
            "date": "2017-11-07T00:00:00+0100"
        }
    ],
    "_links": {
        "self": {
            "href": "/v1/invoices/606470"
        }
    }
}

Requirements

Name	Type	Required	Description
invoice	integer (\d+)		Invoice identifier

Response

Name	Type	Required	Description
id	integer		Identifier
invoice_number	string		Invoice number
created	DateTime		Date created
tax	float		Tax percentage
amount_total	float		Total amount to pay
amount_open	float		Total amount still open
amount_payed	float		Total amount payed
is_open	boolean		Flag whether this invoice is not fully payed
is_payed	boolean		Flag whether this invoice is fully payed
details Show properties	collection		array of objects (Detail)
Properties of Detail Name Type Required Description quantity float Quantity unit_price float Unit price description string Short description of what was invoiced article Show properties model object (Article) Properties of Article Name Type Required Description id integer Article identifier name string Article name
payments Show properties	collection		array of objects (Payment)
Properties of Payment Name Type Required Description date DateTime Date of payment amount float Amount