Consultar facturas

get https://app.aliaddo.net/v1/invoices

Query Params

page

int32

required

Defaults to 1

Desde que número de facturas desea consultar. Por ejemplo para consultar desde la factura 10, se envía page=10. Los resultados varian según el orden en el que se muestra la información.

itemsPerPage

int32

required

Defaults to 10

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

status

string

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

Vigente - Facturas por cobrar
Invalida - Facturas inválidas
Pagada - Facturas con pago total
PagoParcial- Facturas con pago parcial
NotaCredito - Facturas con devolución
NotaCreditoParcial - Facturas con devolución parcial

consecutive

string

Filtrar por consecutivo de la factura

personId

string

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

personIdSeller

string

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

itemId

string

Filtrar las facturas de venta por el id del producto.

date

Filtrar resultados según fecha de creación. Se retornarán todas las facturas de venta que su fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro.
FORMATO: YYYY-MM-DD
ADVERTENCIA: Si completas este campo, ten en cuenta que los campos dueDate, dateAfter y dateBefore se ignorarán.

dueDate

date

Filtrar resultados según fecha de vencimiento de la factura. Se retornarán todas las facturas de venta que coincidan en su fecha de vencimiento (atributo dueDate) con el valor enviado en este parámetro.
FORMATO: YYYY-MM-DD
ADVERTENCIA: Si completas este campo, ten en cuenta que los campos dateAfter y dateBefore se ignorarán.

dateAfter

string

Fecha del documento desde la cual se deben obtener los resultados. Consulta incluyendo 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

branchId

string

branchName

string

branchAddress

string

branchPhone

string

branchPostalCode

string

branchEmail

string

branchCountryCode

string

branchCountryName

string

branchRegionCode

string

branchRegionName

string

branchCityCode

string

branchCityName

string

date

string

dueDate

string

startDate

string

endDate

string

dateDelivery

string

purchaseOrderNumber

string

personId

string

personName

string

personIdentification

string

addressIdBilling

string

addressIdShipping

string

personIdSeller

string

observation

string

customerNote

string

termsAndConditions

string

footer

string

currencyCode

string

exchangeRate

integer

Defaults to 0

subtotalAmount

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

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

paymentAmount

integer

Defaults to 0

creditNoteAmount

integer

Defaults to 0

debitNoteAmount

integer

Defaults to 0

balanceAmount

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

costCenterId

string

paymentFormCode

string

cufe

string

securityCode

string

resolutionId

string

details

array of objects

details

object

string

invoiceId

string

itemId

string

itemCode

string

itemName

string

itemBatchExpiry

string

itemSerialNumbers

array

itemSerialNumbers

itemBatchCode

string

unitMeasurementId

string

unitMeasurementCode

string

unitMeasurementName

string

unitMeasurementCodeConversion

string

unitMeasurementNameConversion

string

warehouseId

string

warehouseName

string

personIdMandator

string

personNameMandator

string

personIdentificationMandator

string

personIdentificationCheckMandator

string

identificationTypeCodeMandator

string

identificationTypeNameMandator

string

description

string

itemLength

integer

Defaults to 0

itemWidth

integer

Defaults to 0

itemHeight

integer

Defaults to 0

itemWeight

integer

Defaults to 0

quantity

integer

Defaults to 0

unitValue

integer

Defaults to 0

unitValueBeforeTax

integer

Defaults to 0

subtotalAmount

integer

Defaults to 0

costAmount

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

isRemitance

boolean

Defaults to true

remitanceNumber

integer

Defaults to 0

remitanceConsecutive

string

remitanceValue

integer

Defaults to 0

remitanceQuantityValue

integer

Defaults to 0

remitanceMeasurementUnit

integer

Defaults to 0

incotermCode

string

typeOfOperationCode

string

createdAt

string

status

string

statusDian

string

stateDian

string

stateDianReason

array of strings

stateDianReason

stateDianDate

string

stateDianLastEventDate

string

stateDianLastEventCude

string

claimConceptCode

string

claimConceptName

string

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://app.aliaddo.net/v1/invoices?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