Daftra API
DocsAll EndpointsDaftra Partners
DocsAll EndpointsDaftra Partners
  1. Invoices
  • Welcome
  • Getting Started
  • Authorization
  • All Endpoints
    • Auth
      • Generate Access Token
    • Invoices
      • GET All Invoices
        GET
      • GET Single Invoice
        GET
      • Edit Invoices
        PUT
      • Delete Invoices
        DELETE
      • Add New Invoice
        POST
    • Estimates
      • GET All Estimates
      • GET Single Estimate
      • Edit Estimates
      • Delete Estimates
      • Add New Estimate
    • Credit Notes
      • GET All Credit Notes
      • GET Single Credit Note
      • Edit Credit Notes
      • Delete Credit Notes
      • Add New Credit Note
    • Refund Receipts
      • GET All Refund Receipts
      • GET Single Refund Receipt
      • Edit Refund Receipts
      • Delete Refund Receipts
      • Add New Refund Receipt
    • Clients
      • GET All Clients
      • GET Single Client
      • Edit Clients
      • Delete Clients
      • Add New Client
    • Suppliers
      • GET All Suppliers
      • GET Single Supplier
      • Edit Suppliers
      • Delete Suppliers
      • Add New Supplier
    • Work Orders
      • GET Single Work Order
      • Edit Work Orders
      • Delete Work Orders
      • GET All Work Orders
      • Add New Work Order
    • Client Appointments
      • GET All Client Appointments
      • GET Single Client Appointment
      • Edit Client Appointments
      • Delete Client Appointments
      • Add New Client Appointment
    • Invoice Appointments
      • GET All Invoice Appointments
      • GET Single Invoice Appointment
      • Edit Invoice Appointments
      • Delete Invoice Appointments
      • Add New Invoice Appointment
    • Estimate Appointments
      • GET All Estimate Appointments
      • GET Single Estimate Appointment
      • Edit Estimate Appointments
      • Delete Estimate Appointments
      • Add New Estimate Appointment
    • Work Order Appointments
      • GET All Work Order Appointments
      • GET Single Work Order Appointment
      • Edit Work Order Appointments
      • Delete Work Order Appointments
      • Add New Work Order Appointment
    • Notes
      • GET All Notes
      • GET Single Note
      • Edit Notes
      • Delete Notes
      • Add New Note
    • Time Tracking
      • GET All Time Tracking
      • GET Single Time Tracking
      • Edit Time Tracking
      • Delete Time Tracking
      • Add New Time Tracking
    • Invoice Payments
      • GET All Invoice Payments
      • GET Single Invoice Payment
      • Edit Invoice Payments
      • Delete Invoice Payments
      • Add New Invoice Payment
    • Client Payments
      • GET All Client Payments
      • GET Single Client Payment
      • Edit Client Payments
      • Delete Client Payments
      • Add New Client Payment
    • Products
      • GET All Products
      • GET Single Product
      • Edit Products
      • Delete Products
      • Add New Product
    • Journals
      • GET All Journals
      • GET Single Journal
      • Edit Journals
      • Delete Journals
      • Add New Journal
    • Journal Accounts
      • GET All Journal Accounts
      • GET Single Journal Account
      • Edit Journal Accounts
      • Delete Journal Accounts
      • Add New Journal Account
    • Journal Cats
      • GET All Journal Cats
      • GET Single Journal Cat
      • Edit Journal Cats
      • Delete Journal Cats
      • Add New Journal Cat
    • Expenses
      • GET All Expenses
      • GET Single Expens
      • Edit Expenses
      • Delete Expenses
      • Add New Expens
    • Incomes
      • GET All Incomes
      • GET Single Income
      • Edit Incomes
      • Delete Incomes
      • Add New Income
    • Taxes
      • GET All Taxes
      • GET Single Taxe
      • Edit Taxes
      • Delete Taxes
      • Add New Taxe
    • Purchase Invoices
      • GET All Purchase Invoices
      • GET Single Purchase Invoice
      • Edit Purchase Invoices
      • Delete Purchase Invoices
      • Add New Purchase Invoice
    • Purchase Refunds
      • GET All Purchase Refunds
      • GET Single Purchase Refund
      • Edit Purchase Refunds
      • Delete Purchase Refunds
      • Add New Purchase Refund
    • Stock Transactions
      • GET All Stock Transactions
      • GET Single Stock Transaction
      • Edit Stock Transactions
      • Delete Stock Transactions
      • Add New Stock Transaction
    • Stores
      • GET All Stores
      • GET Single Store
      • Edit Stores
      • Delete Stores
      • Add New Store
    • Treasuries
      • GET All Treasuries
      • GET Single Treasury
      • Edit Treasuries
      • Delete Treasuries
      • Add New Treasury
    • Product Categories
      • GET All Product Categories
      • GET Single Product Category
    • Staff
      • GET All Staff
      • GET Single Staff
    • Client-attendance-log
      • Add New Client-attendance-log
    • Follow Up Actions
      • GET All Follow Up Actions
      • GET Single Follow Up Action
      • Delete Follow Up Action
    • Follow Up Statuses
      • GET All Follow Up Statuses
      • GET Single Follow Up Status
      • Delete Follow Up Status
    • General Listing
      • GET General Listing
    • Site
      • GET Site Info
  1. Invoices

GET All Invoices

Production
https://{{subdomain}}.daftra.com/api2
Production
https://{{subdomain}}.daftra.com/api2
GET
https://{{subdomain}}.daftra.com/api2
/invoices{format}
Invoices
Request 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 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
20
>= 1<= 1000
Default:
20
page
integer 
optional
1
>= 1
Default:
1
Header Params
Accept
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:
{{apikey}}

Responses

🟢200OK
application/json
OK
Body
code
integer 
optional
Example:
200
result
string 
optional
Example:
successful
data
array [object {1}] 
optional
Invoice
object 
optional
pagination
object (Pagination) 
optional
prev
string  | null 
optional
Example:
/api2/clients/?page=1
next
string  | null 
optional
Example:
/api2/clients/?page=3
page
integer 
optional
Example:
2
page_count
integer 
optional
Example:
5
total_results
integer 
optional
Example:
98
🟠401Unauthorized
🟠403Forbidden
Previous
Generate Access Token
Next
GET Single Invoice