Get Sales Deliveries


                                    GET
                                    /api/v2/sales_deliveries

Use this method to get sales deliveries lists. See our HTTP GET documentation for complete queries method.

The following elements are returned in the get sales deliveries lists methods response :

Body Response

Element	Description
id	Unique code for identifier sales deliveries. String `36 characters`.
status	Status transaction, the status must be one of the following types: `draft`, `deleted`, `submitted`, `approved`, `voided`, `finished`.
date	Transaction date. Date `format YYYY-MM-DD`.
time	Transaction time. Time `format hh:mm:ss`.
number	Reference number of sales deliveries. String `maximum 35 characters`.
description	Description of sales deliveries. String `maximum 75 characters`.
customer*	Element for customer.
customer.id	Unique code for identifier customer. String `36 characters`.
customer.code	Customer code String `maximum 255 characters`.
customer.name	Customer name String `maximum 255 characters`.
customer.classification*	Element for customer classification.
customer.classification.id	Unique code for identifier classification. String `36 characters`.
customer.classification.name	Classification name String `maximum 255 characters`.
billing_address*	Element for billing address.
billing_address.complete_address	Billing address complete String
billing_address.district	District name String
billing_address.city	City name String
billing_address.state	State name String
billing_address.country	Country name String
billing_address.postal_code	Postal code String
shipping_address*	Element for shipping address.
shipping_address.complete_address	Shipping Address complete String
shipping_address.district	District name String
shipping_address.city	City name String
shipping_address.state	State name String
shipping_address.country	Country name String
shipping_address.postal_code	Postal code String
employees*	Element for employees.
employees.id	Unique code for identifier employees. String `36 characters`.
employees.type*	employees.type
employees.type.id	Unique code for identifier employees type. String `36 characters`.
employees.type.name	employees type name. String `36 characters`.
employees.contact.id	Unique code for identifier contact. String `36 characters`.
employees.contact.code	Contact code String `maximum 255 characters`.
employees.contact.name	Contact name String `maximum 255 characters`.
employees.contact.classification.id	Unique code for identifier classification. String `36 characters`.
employees.contact.classification.name	Contact classification name String `maximum 255 characters`.
term_of_payment*	Element for term_of_payment.
term_of_payment.base_date	Base date period of credit transaction, for customer and vendor type date `format YYYY-MM-DD`.
term_of_payment.percentage	Due date period of credit transaction, for customer and vendor type. Integer.
term_of_payment.due_date	Due date period of credit transaction, for customer and vendor type date `format YYYY-MM-DD`.
term_of_payment.due_days	Due date period of credit transaction, for customer and vendor type. Integer.
term_of_payment.late_charge_rate	Credit transaction late charge Integer.
term_of_payment.discount_days	Discount day, for customer and vendor type Integer.
term_of_payment.early_discount_rate	Early discount, for customer and vendor type Integer.
currency*	Element for currency.
currency.id	Unique code for identifier currency. String `36 characters`.
currency.code	Currency code String `maximum 3 characters`.
currency.name	Currency name String `maximum 255 characters`.
currency.symbol	Currency symbol String `maximum 255 characters`.
exchange_rate	Exchange rate number
department*	Department of sales deliveries.
department.id	Unique code for identifier customer. String `36 characters`.
department.code	Customer code String `maximum 255 characters`.
department.name	Customer name String `maximum 255 characters`.
project*	Project of sales deliveries.
project.id	Unique code for identifier project. String `36 characters`.
project.code	Project code String `maximum 255 characters`.
project.name	Project name String `maximum 255 characters`.
warehouse*	Warehouse of sales deliveries.
warehouse.id	Unique code for identifier department. String `36 characters`.
warehouse.code	Warehouse code String `maximum 255 characters`.
warehouse.name	Warehouse name String `maximum 255 characters`.
document*	Document of sales deliveries.
document.date	Document date. Date Time `format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format)`. Automaticaly.
document.number	Document number String.
other_fields	Element for other_fields
other_fields.id	Unique code for identifier other_fields. String `36 characters`.
other_fields.key	key words of other_fields. String `36 characters`.
other_fields.type	other_fields type. String `36 characters`.
other_fields.value	other_fields value. String `36 characters`.
attachments*	attachments.
attachments.id	Unique code for identifier attachments. String `36 characters`.
attachments.name	Attachments name String.
attachments.extension	Attachments extension `JPG, PNG, PDF` String.
attachments.url	Attachments url String.
line_amount_type	`tax_exclusive` String.
line_items*	line_items of sales deliveries
line_items.id	Unique code for identifier line_items. String `36 characters`.
line_items.description	line_items description Number
line_items.quantity	line_items quantity Number
line_items.unit_price	line_items unit_price Number
line_items.note	line_items note Number
line_items.discount*	Line items discount.
line_items.discount.rate	Discount rate Number
line_items.discount.amount	Discount amount Number
line_items product*	line_items Product data.
line_items.product.id	Unique code for identifier product. String `36 characters`.
line_items.product.code	Product code String `maximum 255 characters`.
line_items.product.name	Product name String `maximum 255 characters`.
line_items.unit*	line_items unit.
line_items.unit.id	Unique code for identifier unit. String `36 characters`.
line_items.unit.code	Unit code String `maximum 255 characters`.
line_items.unit.name	Unit name String `maximum 255 characters`.
line_items.account*	line_items account data .
line_items.account.id	Unique code for identifier account. String `36 characters`.
line_items.account.code	Account code String `maximum 255 characters`.
line_items.account.name	Account name String `maximum 255 characters`.
line_items.account.alias_name	Account alias name String `maximum 255 characters`.
line_items.departement*	Departement data .
line_items.departement.id	Unique code for identifier department. String `36 characters`.
line_items.departement.code	Departement code String `maximum 255 characters`.
line_items.departement.name	Departement name String `maximum 255 characters`.
line_items.project*	Project of sales deliveries.
line_items.project.id	Unique code for identifier project. String `36 characters`.
line_items.project.code	Project code String `maximum 255 characters`.
line_items.project.name	Project name String `maximum 255 characters`.
line_items.warehouse*	Warehouse data.
line_items.warehouse.id	Unique code for identifier warehouse. String `36 characters`.
line_items.warehouse.code	Warehouse code String `maximum 255 characters`.
line_items.warehouse.name	Warehouse code String `maximum 255 characters`.
final_discount*	Final discount of sales deliveries.
final_discount.type	Unique code for identifier department. String `36 characters`.
final_discount.description	Warehouse code String `maximum 255 characters`.
final_discount.rate	Warehouse name String `maximum 255 characters`
final_discount.amount	Warehouse name String `maximum 255 characters`
final_discount.account*	account
final_discount.account.id	Unique code for identifier final_discount account. String `36 characters`.
final_discount.account.code	final_discount account code String `maximum 255 characters`
final_discount.account.name	final_discount account name String `maximum 255 characters`.
others*	Element for others.
others.id	Unique code for identifier others.id. String `36 characters`.
others.description	others description String `maximum 255 characters`.
others.amount	others number Number `maximum 255 characters`.
others.account*	Account data .
others.account.id	Unique code for identifier account. String `36 characters`.
others.account.code	Account code String `maximum 255 characters`.
others.account.name	Account name String `maximum 255 characters`.
others.currency*	others currency.
others.currency.id	Unique code for identifier currency String `36 characters`.
others.currency.code	currency code String `255 characters`.
others.currency.name	currency name String `255 characters`.
others.currency.symbol	currency symbol String `255 characters`.
others.exchange_rate	Exchange_rate Number.
total_amount	total_amount Number.
orders*	Element for orders.
orders.id	Unique code for identifier orders.id. String `36 characters`.
orders.date	orders date Date Time `format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format)`.
orders.number	orders number Number `maximum 255 characters`.
orders.description	orders description Number `maximum 255 characters`.
created*	Element for Created.
created.user*	Created User.
created.user.id	User id String Automaticaly.
created.user.name	User name String.
created.user.email	User email String.
created.time	Date Time `format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format)`. Automaticaly.
update*	Element for Update.
update.user*	Update user.
update.user.id	User id String Automaticaly.
update.user.name	User name String.
update.user.email	User email String.
update.time	Date Time `format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format)`. Automaticaly.

Request

Headers


                                  Slug  : 
                   example.zahironline.com
                  

                                  Authorization  : 
                   Bearer xqVjYbKwd6JERiaUMPM1hWqH1RUUPBlfcb40Y6NU

Response
200

Body

                        
                                                      {
    "count": 3,
    "page_context": {
        "page": 1,
        "per_page": 10,
        "total_pages": 1
    },
    "links": {
        "first": "https://apps.zahironline.com/api/v2/sales_deliveries?page=1&per_page=10",
        "previous": null,
        "next": null,
        "last": "https://apps.zahironline.com/api/v2/sales_deliveries?page=1&per_page=10"
    },
    "results": [
        {
            "id": "fe5c7735-0597-4c9a-a85a-aeaae3e88603",
            "status": "submitted",
            "is_recalculated": false,
            "date": "2020-03-09",
            "number": "SD000003",
            "description": "Sales Deliveries, General Customer Jakarta Selatan",
            "Customer": {
                "id": "62554e4c-0242-4364-be0e-125547a98b0a",
                "code": "CUST",
                "name": "General Customer",
                "classification": {
                    "id": "9a781d77-66ae-44df-82ad-e5f595f4d5a8",
                    "name": "General"
                }
            },
            "billing_address": {
                "id": "84b39852-1dd3-441c-ba5d-d9fa18806e1a"
            },
            "shipping_address": {
                "id": "6a171640-0bf7-4cb2-8aa8-39ef1c23b0df"
            },
            "currency": {
                "id": "0769703c-0eab-8e4d-a27f-fa685f3bee5e",
                "code": "IDR",
                "name": "Indonesian rupiah",
                "symbol": "Rp"
            },
            "exchange_rate": 1,
            "department": {
                "id": "9a55d668-b419-774a-ac8e-6a702630eb73",
                "code": 99,
                "name": "Head Quarter"
            },
            "project": {
                "id": "00f99795-52bb-47b1-ae34-02519ef10a59",
                "code": "N/A",
                "name": "N/A"
            },
            "warehouse": {
                "id": "a84109b7-4e96-3442-b3f3-72fd5cd25d44",
                "code": "Head Quarter",
                "name": "Head Quarter"
            },
            "line_amount_type": "tax_exclusive",
            "subtotal_origin": 47500,
            "subtotal": 47500,
            "total_discount_origin": 2375,
            "total_discount": 2375,
            "subtotal_before_tax_origin": 45125,
            "subtotal_before_tax": 45125,
            "total_tax_origin": 4512.5,
            "total_tax": 4512.5,
            "total_other_origin": 1000,
            "total_other": 1000,
            "total_amount_origin": 50637.5,
            "total_amount": 50637.5,
            "created": {
                "user": {
                    "id": "9ac70127-cffb-49eb-8731-66b99bbb68eb",
                    "name": "User Zahir Online",
                    "email": "userzahir@gmail.com"
                },
                "time": "2020-03-09T09:07:07+00:00"
            },
            "updated": {
                "user": {
                    "id": "9ac70127-cffb-49eb-8731-66b99bbb68eb",
                    "name": "User Zahir Online",
                    "email": "userzahir@gmail.com"
                },
                "time": "2020-03-09T09:15:57+00:00"
            },
            "total_quantity": 0,
            "total_item": 0
        },
        {
            "id": "24edfb11-5a5c-43b1-941f-0781de9a52af",
            "status": "approved",
            "is_recalculated": false,
            "date": "2019-10-31",
            "number": "SD000002",
            "description": "Sales Deliveries, General Customer",
            "Customer": {
                "id": "62554e4c-0242-4364-be0e-125547a98b0a",
                "code": "CUST",
                "name": "General Customer",
                "classification": {
                    "id": "9a781d77-66ae-44df-82ad-e5f595f4d5a8",
                    "name": "General"
                }
            },
            "currency": {
                "id": "0769703c-0eab-8e4d-a27f-fa685f3bee5e",
                "code": "IDR",
                "name": "Indonesian rupiah",
                "symbol": "Rp"
            },
            "exchange_rate": 1,
            "department": {
                "id": "9a55d668-b419-774a-ac8e-6a702630eb73",
                "code": 99,
                "name": "Head Quarter"
            },
            "project": {
                "id": "00f99795-52bb-47b1-ae34-02519ef10a59",
                "code": "N/A",
                "name": "N/A"
            },
            "warehouse": {
                "id": "a84109b7-4e96-3442-b3f3-72fd5cd25d44",
                "code": "Head Quarter",
                "name": "Head Quarter"
            },
            "line_amount_type": "tax_exclusive",
            "subtotal_origin": 40000,
            "subtotal": 40000,
            "total_discount_origin": 0,
            "total_discount": 0,
            "subtotal_before_tax_origin": 40000,
            "subtotal_before_tax": 40000,
            "total_tax_origin": 0,
            "total_tax": 0,
            "total_other_origin": 0,
            "total_other": 0,
            "total_amount_origin": 40000,
            "total_amount": 40000,
            "created": {
                "user": {
                    "id": "9ac70127-cffb-49eb-8731-66b99bbb68eb",
                    "name": "User Zahir Online",
                    "email": "userzahir@gmail.com"
                },
                "time": "2019-10-31T15:15:42+00:00"
            },
            "updated": {
                "time": "2019-10-31T15:15:42+00:00"
            },
            "total_quantity": 0,
            "total_item": 0
        },
        {
            "id": "7d22a77a-856f-4d79-af59-8c6d10eaf003",
            "status": "approved",
            "is_recalculated": false,
            "date": "2019-10-23",
            "number": "SD000001",
            "description": "Sales Deliveries, General Customer",
            "Customer": {
                "id": "62554e4c-0242-4364-be0e-125547a98b0a",
                "code": "CUST",
                "name": "General Customer",
                "classification": {
                    "id": "9a781d77-66ae-44df-82ad-e5f595f4d5a8",
                    "name": "General"
                }
            },
            "currency": {
                "id": "0769703c-0eab-8e4d-a27f-fa685f3bee5e",
                "code": "IDR",
                "name": "Indonesian rupiah",
                "symbol": "Rp"
            },
            "exchange_rate": 1,
            "department": {
                "id": "9a55d668-b419-774a-ac8e-6a702630eb73",
                "code": 99,
                "name": "Head Quarter"
            },
            "project": {
                "id": "00f99795-52bb-47b1-ae34-02519ef10a59",
                "code": "N/A",
                "name": "N/A"
            },
            "warehouse": {
                "id": "a84109b7-4e96-3442-b3f3-72fd5cd25d44",
                "code": "Head Quarter",
                "name": "Head Quarter"
            },
            "line_amount_type": "tax_exclusive",
            "subtotal_origin": 30000,
            "subtotal": 30000,
            "total_discount_origin": 0,
            "total_discount": 0,
            "subtotal_before_tax_origin": 30000,
            "subtotal_before_tax": 30000,
            "total_tax_origin": 0,
            "total_tax": 0,
            "total_other_origin": 0,
            "total_other": 0,
            "total_amount_origin": 30000,
            "total_amount": 30000,
            "created": {
                "user": {
                    "id": "9ac70127-cffb-49eb-8731-66b99bbb68eb",
                    "name": "User Zahir Online",
                    "email": "userzahir@gmail.com"
                },
                "time": "2019-10-23T07:28:33+00:00"
            },
            "updated": {
                "time": "2019-10-23T07:28:33+00:00"
            },
            "total_quantity": 0,
            "total_item": 0
        }
    ]
}

Get Sales Deliveries

Request

Headers

Response 200

Body

Response
200