Consultar ordenes de venta

get https://app.aliaddo.net/v1/sales-orders

Query Params

page

int32

required

Defaults to 1

Desde que número de ordenes de venta desea consultar. Por ejemplo para consultar desde la órden de venta 10, se envía page=10. Los resultados varían según el orden en el que se muestra la información.

itemsPerPage

int32

required

Defaults to 10

Cantidad de ordenes de venta por página. Por defecto retorna 10 ordenes de venta. La cantidad máxima de ordenes de venta son 50, si este valor es mayor que 50, la aplicación retorna un mensaje de error.

status

string

Filtrar resultados según el estado de la orden de venta. Se retornarán todas las ordenes de venta que coincidan en su estado.

consecutive

string

Filtrar por consecutivo de la orden de venta

personId

string

Filtrar resultados según el identificador (ID) del cliente de la orden de venta. Se retornarán todas las ordenes de venta que estén asociadas a un cliente.

personIdSeller

string

Filtrar resultados según el identificador (ID) del vendedor de la orden de venta. Se retornarán todas las ordenes de venta que estén asociadas a un vendedor.

itemId

string

Filtrar las ordenes de venta por el id del producto.

date

Filtrar resultados según fecha de creación de la orden de venta. Se retornarán todas las ordenes de venta que su fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro.
FORMATO: YYYY-MM-DD

dueDate

date

Filtrar resultados según fecha de vencimiento de la orden de venta. Se retornarán todas las ordenes de venta que coincidan en su fecha de vencimiento (atributo dueDate) con el valor enviado en este parámetro.
FORMATO: YYYY-MM-DD

dateAfter

string

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde la fecha filtrada en adelante
FORMATO: YYYY-MM-DD

dateBefore

string

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde la fecha filtrada para atrás
FORMATO: YYYY-MM-DD

Responses

Response body

array of objects

object

string

consecutive

string

date

string

dueDate

string

branchId

string

branchName

string

branchAddress

string

branchPhone

string

branchPostalCode

string

branchEmail

string

branchCountryName

string

branchRegionName

string

branchCityName

string

personId

string

personName

string

personIdentification

string

identificationTypeName

string

addressIdBilling

string

addressBillingName

string

addressBillingLine

string

addressBillingNeighborhood

string

addressBillingPhone

string

addressBillingPostalCode

string

addressBillingCountryName

string

addressBillingRegionName

string

addressBillingCityName

string

addressIdShipping

string

addressShippingName

string

addressShippingLine

string

addressShippingNeighborhood

string

addressShippingPhone

string

addressShippingPostalCode

string

addressShippingCountryName

string

addressShippingRegionName

string

addressShippingCityName

string

costCenterId

string

costCenterName

string

personIdSeller

string

personNameSeller

string

personFullIdentificationSeller

string

details

array of objects

details

object

string

salesOrderId

string

itemId

string

itemCode

string

itemName

string

itemBatchCode

string

itemCategoryName

string

unitMeasurementId

string

unitMeasurementName

string

unitMeasurementNameConversion

string

warehouseId

string

warehouseName

string

personIdMandator

string

personNameMandator

string

personIdentificationMandator

string

personIdentificationCheckMandator

string

identificationTypeNameMandator

string

isGift

boolean

Defaults to true

description

string

quantity

integer

Defaults to 0

unitValue

integer

Defaults to 0

unitValueBeforeTax

integer

Defaults to 0

subtotalAmount

integer

Defaults to 0

discountRate

integer

Defaults to 0

discountIsPercent

boolean

Defaults to true

discountAmount

integer

Defaults to 0

taxes

array of objects

taxes

object

string

name

string

categoryCode

string

rate

integer

Defaults to 0

rateKind

string

amount

integer

Defaults to 0

withholdings

array of objects

withholdings

object

string

name

string

categoryCode

string

rate

integer

Defaults to 0

rateKind

string

amount

integer

Defaults to 0

unitMeasurementIdConversion

string

quantityConversion

integer

Defaults to 0

unitValueConversion

integer

Defaults to 0

dateDelivery

string

purchaseOrderNumber

string

observation

string

customerNote

string

termsAndConditions

string

currencyCode

string

exchangeRate

integer

Defaults to 0

subtotalAmount

integer

Defaults to 0

discount

integer

Defaults to 0

discountAmount

integer

Defaults to 0

discountAmountDetail

integer

Defaults to 0

discounts

array

discounts

chargeAmount

integer

Defaults to 0

chargeAmountDetail

integer

Defaults to 0

charges

array

charges

subtotalWithDiscount

integer

Defaults to 0

taxAmount

integer

Defaults to 0

withholdingAmount

integer

Defaults to 0

withholdingAmountIca

integer

Defaults to 0

withholdingAmountVat

integer

Defaults to 0

adjustAmount

integer

Defaults to 0

roundAmount

integer

Defaults to 0

advanceAmount

integer

Defaults to 0

totalAmount

integer

Defaults to 0

taxes

array of objects

taxes

object

string

name

string

categoryCode

string

rate

integer

Defaults to 0

rateKind

string

amount

integer

Defaults to 0

withholdings

array of objects

withholdings

object

string

name

string

categoryCode

string

rate

integer

Defaults to 0

rateKind

string

amount

integer

Defaults to 0

acceptedOrRejected

string

acceptedOrRejectedReason

string

acceptedOrRejectedDate

string

paymentFormCode

string

paymentFormName

string

paymentMeanCode

string

createdAt

string

status

string

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://app.aliaddo.net/v1/sales-orders?page=1&itemsPerPage=10' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400