Get Purchase Returns

Use this method to get purchase returns lists. See our HTTP GET documentation for complete queries method.

The following elements are returned in the get purchase returns lists methods response :

Body Response

Element Description
id Unique code for identifier purchase deliveries. String 36 characters.
type Type of transaction.
status Status transaction, the status must be one of the following types: draft, deleted, submitted, approved, voided, finished.
payment_status The payment status must be one of the following types: open, unpaid, overdue, partialy_paid, overpaid, paid.
is_recalculated true if is is_recalculated or false if is not is_recalculated Boolean.
date Transaction date. Date format YYYY-MM-DD.
number Reference number of purchase deliveries. String maximum 35 characters.
description Description of purchase deliveries. String maximum 75 characters.
supplier* Element for supplier.
supplier.id Unique code for identifier supplier. String 36 characters.
supplier.code supplier code String maximum 255 characters.
supplier.name supplier name String maximum 255 characters.
supplier.bussiness_id_number supplier bussiness id number. String 35 characters.
supplier.tax_id_number supplier tax id number String maximum 35 characters.
supplier.is_supplier true if is supplier or false if not supplier Boolean.
supplier.is_supplier true if is supplier or false if not supplier Boolean.
supplier.is_employee true if is employee or false if not employee Boolean.
supplier.is_active true if active or false if not active Boolean.
supplier.classification* Element for supplier classification.
supplier.classification.id Unique code for identifier classification. String Automatically.
supplier.classification.name Classification name String maximum 255 characters.
supplier.default_currency.id Unique code for identifier currency. String 36 characters.
supplier.default_currency.code Currency code String maximum 3 characters.
supplier.default_currency.name Currency name String maximum 150 characters.
supplier.default_currency.symbol Currency symbol String maximum 255 characters.
supplier.addresses* Element of supplier addresses
supplier.addresses.id Address id.
supplier.addresses.is_primary Boolean true if primary false if not primary.
supplier.addresses.type Addresses type String Billing Address or Shipping Address.
supplier.addresses.complete_address Complete addresses String.
supplier.addresses.district District addresses String.
supplier.addresses.city City name String.
supplier.addresses.state State name String.
supplier.addresses.country_code Country Code String.
supplier.addresses.country_name Country name String.
supplier.addresses.postal_code Postal Code String.
supplier.addresses.latitude latitude addresses String.
supplier.addresses.longitude longitude addresses String.
supplier.phones* Element of supplier phones String.
supplier.phones.id Phones id String.
supplier.phones.is_primary Boolean true if primary false if not primary.
supplier.phones.type Phones type String Ex: Handphone or Telephone
supplier.phones.value Phones Number String.
supplier.emails* Element of emails String.
supplier.emails.id Emails id String.
supplier.emails.is_primary Boolean true if primary false if not primary.
supplier.emails.type Email type String Ex: office email or personal email
supplier.emails.value Email Address String.
supplier.contact_persons* Element of Contacts person.
supplier.contact_persons.id Contact persons id String.
supplier.contact_persons.is_primary Boolean true if primary false if not primary.
supplier.contact_persons.designation Contact persons type String Ex: Manager, Staff, Office Boy
supplier.contact_persons.name Contact persons name String.
supplier.other_fields* Element of supplier other fields.
supplier.other_fields.id other_fields id String.
supplier.other_fields.key other_fields key String.
supplier.other_fields.type other_fields data type Ex: string or integer or number
supplier.other_fields.value value of other_fields String.
supplier.attachments* Element of attachments.
supplier.attachments.id Attachments id String.
supplier.attachments.name Attachments name String.
supplier.attachments.extension Attachments extension Ex: JPG, Doc, PDF String.
supplier.attachments.url Attachments url String.
orders.id Unique code for identifier orders. 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.
deliveries* deliveries data.
deliveries.id Unique code for identifier deliveries String 36 characters.
deliveries.date deliveries date Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format).
deliveries.number deliveries number Number maximum 255 characters.
deliveries.description deliveries description String maximum 255 characters.
parent_memo* The parent memo is filled with the invoice number you want to return in the credit / debit note column.
parent_memo.id Unique code for identifier parent_memo. String 36 characters.
parent_memo.status parent_memo status String maximum 3 characters.
parent_memo.date parent_memo date Date format YYYY-MM-DD.
parent_memo.time parent_memo time Time format hh:mm:ss.
parent_memo.number parent_memo number String maximum 255 characters.
billing_address.complete_address Billing address complete String
billing_address.district Billing Address district String
billing_address.city Billing Address city String
billing_address.state Billing Address state String
billing_address.country Billing Address country String
billing_address.postal_code Billing Address postal code String
shipping_address* Shipping Address Data
shipping_address.complete_address Shipping Address complete String
shipping_address.district Shipping Address district String
shipping_address.city Shipping Address city String
shipping_address.state Shipping Address state String
shipping_address.country Shipping Address country String
shipping_address.postal_code Shipping Address 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* Element for Contact.
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* contact classification.
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_payments.due_date Due date period of credit transaction, for supplier and vendor type. Integer.
term_of_payments.due_days Due days period of credit transaction, for supplier and vendor type. Integer.
term_of_payments.late_charge_rate Credit transaction late charge Integer.
term_of_payments.discount_days Discount day, for supplier and vendor type Integer.
term_of_payments.early_discount_rate Early discount, for supplier and vendor type Integer.
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.id Unique code for identifier supplier. String 36 characters.
Department.code supplier code String maximum 255 characters.
Department.name supplier name String maximum 255 characters.
project* Project of purchase invoices.
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 purchase invoices.
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.
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 purchase invoices
line_items.id Unique code for identifier line_items. String 36 characters.
line_items.order* Element for order.
line_items.order.id Unique code for identifier order.id. String 36 characters.
line_items.order.description order description String maximum 255 characters.
line_items.order.quantity order quantity Number maximum 255 characters.
line_items.order.unit_price order unit_price Number maximum 255 characters.
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 purchase invoices.
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.
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.quantity line_items quantity Number
line_items.unit_price line_items unit_price Number
line_items.discount* Line items discount.
line_items.discount.rate Discount rate Number
line_items.discount.amount Discount amount Number
line_items.description Line items description maximum 255 characters.
line_items.description_on_invoice Line items description on invoice maximum 255 characters.
line_items.description_on_payment Line items description on payment maximum 255 characters.
line_items.taxes.id Tax id Automatically
line_items.taxes.code Tax code maximum 255 characters.
line_items.taxes.name Tax Name maximum 255 characters.
line_items.taxes.rate Tax rate.
others.id Unique code for identifier others.id. String 36 characters.
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.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.input_type others number Number maximum 255 characters.
others.exchange_rate Exchange_rate Number.
others.amount_origin Exchange_rate Number.
others.amount Exchange_rate Number.
others.description others description String maximum 255 characters.
prepayments* Element for prepayments.
prepayments.id Unique code for identifier others.id. String 36 characters.
prepayments.date prepayments date Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format).
prepayments.number prepayments number Number maximum 255 characters.
prepayments.account.id Unique code for identifier prepayments account String 36 characters.
prepayments.account.code prepayments account code String 255 characters.
prepayments.account.name prepayments account name String 255 characters.
prepayments.currency.id Unique code for identifier prepayments currency String 36 characters.
prepayments.currency.code prepayments currency code String 255 characters.
prepayments.currency.name prepayments currency name String 255 characters.
prepayments.currency.symbol prepayments currency symbol String 255 characters.
prepayments.exchange_rate prepayments Exchange_rate Number.
prepayments.amount_origin prepayments amount origin Number.
prepayments.amount prepayments amount Number.
prepayments.description prepayments description String maximum 255 characters.
payments* Element for payments.
payments.id Unique code for identifier others.id. String 36 characters.
payments.is_cash true for payment is cash Boolean.
payments.payment_method.id Unique code for identifier payments method String 36 characters.
payments.payment_method.name Payment method name String 255 characters.
payments.account.id Unique code for identifier prepayments account String 36 characters.
payments.account.code prepayments account code String 255 characters.
payments.account.name prepayments account name String 255 characters.
payments.currency.id Unique code for identifier prepayments currency String 36 characters.
payments.currency.code prepayments currency code String 255 characters.
payments.currency.name prepayments currency name String 255 characters.
payments.currency.symbol prepayments currency symbol String 255 characters.
payments.amount payments amount. Number.
payments.amount_paid payments amount paid. Number.
payments.description payments description String 255 characters.
payments.input_type payments number Number maximum 255 characters.
payments.exchange_rate payments Exchange rate Number.
payments.amount_origin payments amount origin Number.
payments.amount payments amountNumber.
payments.description payments description String maximum 255 characters.
subtotal_origin Sub total amount in real currency Number.
subtotal total amount in base currency Number.
total_discount_origin Total discount in real currency Number.
total_discount Total discount in base currency Number.
subtotal_before_tax_origin Subtotal before tax in real currency Number.
subtotal_before_tax Subtotal before tax in base currency Number.
total_tax_origin total tax in real currency Number.
total_tax total tax in base currency Number.
total_other_origin total other in real currency Number.
total_other total other in base currency Number.
total_amount_origin total amount in real currency Number.
total_amount total amount in base currency Number.
receivable_origin total receivable in real currency Number.
receivable total receivable in base currency Number.
balance_origin balance amount in real currency Number.
balance balance amount in base currency Number.
created* 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* 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.
total_quantity total_quantity Number.
total_item total_item Number.