Daftra API

GET All Invoices

Production

https://{{subdomain}}.daftra.com/api2

GET

/invoices{format}

Invoices

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://.daftra.com/api2/invoices?limit&page' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "code": 200,
    "result": "successful",
    "data": [
        {
            "Invoice": {
                "id": 26,
                "staff_id": 0,
                "subscription_id": null,
                "store_id": 0,
                "type": "0 => Invoice",
                "no": "0700000AAAAA0001",
                "po_number": 26,
                "name": "string",
                "client_id": 15,
                "is_offline": true,
                "currency_code": "USD",
                "client_business_name": "Example Client",
                "client_first_name": "Example",
                "client_last_name": "Client",
                "client_email": "client@example.com",
                "client_address1": "string",
                "client_address2": "string",
                "client_postal_code": "string",
                "client_city": "string",
                "client_state": "string",
                "client_country_code": "EG",
                "date": "2018-11-07",
                "payment_status": "null => Unpaid",
                "draft": "0",
                "discount": 0,
                "discount_amount": 0,
                "deposit": 0,
                "deposit_type": 0,
                "summary_subtotal": 0,
                "summary_discount": 0,
                "summary_total": 0,
                "summary_paid": 0,
                "summary_unpaid": 0,
                "summary_deposit": 0,
                "summary_refund": 0,
                "notes": "string",
                "html_notes": "string",
                "created": "2018-11-07",
                "modified": "2018-11-07",
                "invoice_layout_id": 1,
                "estimate_id": "The primary store id",
                "shipping_options": "",
                "shipping_amount": null,
                "client_active_secondary_address": true,
                "client_secondary_name": "string",
                "client_secondary_address1": "string",
                "client_secondary_address2": "string",
                "client_secondary_city": "string",
                "client_secondary_state": "string",
                "client_secondary_postal_code": "string",
                "client_secondary_country_code": "string",
                "follow_up_status": null,
                "work_order_id": null,
                "requisition_delivery_status": null,
                "pos_shift_id": null,
                "source_type": null,
                "source_id": null,
                "qr_code_url": "https://yoursite.daftra.com/qr/?d64=QVE1TmIyaGhiV1ZrSUVGemFISmhaZ0lJTVRFMU16WTJRMUlERkRJd01qSXRNVEF0TWpoVU1EQTZNREU2TVRWYUJBRXdCUUV3",
                "invoice_html_url": "https://yoursite.daftra.com/invoices/preview/2621?hash=c06543fe13bd4850b521733687c53259",
                "invoice_pdf_url": "https://yoursite.daftra.com/invoices/view/2621.pdf?hash=c06543fe13bd4850b521733687c53259",
                "Client": {
                    "id": 512,
                    "is_offline": true,
                    "client_number": "0000715",
                    "staff_id": 0,
                    "business_name": "John Smith",
                    "first_name": "",
                    "last_name": "",
                    "email": "user@example.com",
                    "address1": "string",
                    "address2": "string",
                    "city": "string",
                    "state": "string",
                    "postal_code": "string",
                    "phone1": "string",
                    "phone2": "string",
                    "country_code": "str",
                    "notes": "string",
                    "active_secondary_address": true,
                    "secondary_name": "string",
                    "secondary_address1": "string",
                    "secondary_address2": "string",
                    "secondary_city": "string",
                    "secondary_state": "string",
                    "secondary_postal_code": "string",
                    "secondary_country_code": "string",
                    "default_currency_code": "strin",
                    "last_login": "2018-05-10 00:42:00",
                    "suspend": true,
                    "last_ip": "127.0.0.1",
                    "created": "2018-05-10 00:42:00",
                    "modified": "2018-05-12 13:05:06",
                    "follow_up_status": null,
                    "category": "string",
                    "group_price_id": 0,
                    "timezone": 0,
                    "bn1": "string",
                    "bn1_label": "string",
                    "bn2_label": "string",
                    "bn2": "string",
                    "starting_balance": null,
                    "type": null,
                    "birth_date": "2018-05-10",
                    "gender": null,
                    "map_location": null,
                    "credit_limit": 0,
                    "credit_period": 0
                }
            }
        }
    ],
    "pagination": {
        "prev": "/api2/clients/?page=1",
        "next": "/api2/clients/?page=3",
        "page": 2,
        "page_count": 5,
        "total_results": 98
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

format

string

required

Query Params

limit

integer

optional

>= 1<= 1000

Default:

page

integer

optional

>= 1

Default:

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

You can generate the bearer token using the the authorization endpoint then use it here to be able to operate over your account's data

Default:

Bearer {{access_token}}

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Responses

🟢200OK

application/json

Body

code

integer

optional

Example:

200

result

string

optional

Example:

successful

data

array [object {1}]

optional

Invoice

object

optional

pagination

object (Pagination)

optional

string | null

optional

Example:

/api2/clients/?page=1

string | null

optional

Example:

/api2/clients/?page=3

page

integer

optional

Example:

page_count

integer

optional

Example:

total_results

integer

optional

Example:

🟠401Unauthorized

🟠403Forbidden

Generate Access Token

GET Single Invoice