REST API: Purchase and sales sync

rememberme · required — Session token returned by the login.

order · optional — Cost center id (Cost centers). Defaults to the user's active cost center.

cursor string · optional — Cursor from the previous call. When sent, changedSince and $filter are ignored.

changedSince date · optional — Changes since this day, as YYYY-MM-DD. Cannot be later than today.

$filter string · optional — Filter on each endpoint's fields (see Filter). It is stored in the cursor: send it only on the first call.

rows integer · optional — Changes per page, from 1 to 100. Defaults to 100.

includeInternal boolean · optional — false excludes internal vendors or customers. Defaults to true.

inserts array — Documents created since the cursor. On the first load, all of them.

updates array — Documents created before and updated after. Each document appears once, in its current state.

deletes array — Deleted documents: id string and deletedAt date.

cursor string — For the next call. null if the first load returns nothing.

hasMore boolean — true if more changes are available.

Changes from the last 5 minutes arrive on the next call.

deletes is not filtered: ignore any id you don't have.

A document that stops matching the filter does not appear in deletes.

The same id can appear in both updates and deletes on one page: apply the most recent one by comparing updatedAt and deletedAt.

Changes to vendor or customer data (name, tax id, accounts…) do not mark their documents as updated.

Dates: YYYY-MM-DD without quotes. All operators allowed.

Ids: number without quotes. Only eq, ne and in.

Text: in single quotes. Only eq, ne, in and contains(). Case- and accent-sensitive.

onlyValidated boolean · optional — true returns only validated invoices. Defaults to false.

idVendor string · optional — Only invoices from this vendor.

id string — Invoice id.

invoiceNum string — Vendor's invoice number.

documentNum string — Internal document number.

date, dateAccounting, dateDue date — Invoice date, accounting date (if null, use date) and due date.

createdAt, updatedAt date — Created and last updated.

idVendor, vendor, codeVendor, accountVendor, nif string — Vendor: id, name, code, ledger account and tax id.

inEuropeanUnion, inVies boolean — Intra-EU vendor and registered in VIES.

country string — Vendor's country.

paid, validated, locked boolean — Paid, validated and locked.

comment string — Comment.

codePaymentType string — Payment method code.

idCostTypeVendor, costTypeVendor, codeCostTypeVendor, accountCostTypeVendor, accountAuxCostTypeVendor string — Vendor's default cost account: id, name, code, ledger account and auxiliary account.

idBusinessLine, businessLine, codeBusinessLine string — Business line.

idDocument, extDocument string — Attached document: id and extension.

base, taxes, total number — Tax base, taxes and total. total includes withholding.

listTaxes array — Taxes: id, type, base, percent and total. type: 0 VAT · 1 shipping · 2 discount · 3 other · 4 withholding.

listCostTypeTaxes array — VAT by cost account, calculated from received lines: account id and descr (null if the lines have none) and listTaxes (type, base, percent, total).

listDeliveries array — The invoice's delivery notes, with the fields in Purchase delivery notes (without createdAt or updatedAt).

idVendor string · optional — Only delivery notes from this vendor.

id string — Delivery note id.

deliveryNum string — Delivery note number.

deliveryFor string — Delivery note reference, usually the order number.

date date — Received date; if none, the sent date. dateFormatted string — The same, as YYYY/MM/DD.

dateSent date — Order sent date. dateSentFormatted string — The same, as YYYY/MM/DD.

createdAt, updatedAt date — Created and last updated.

idVendor, vendor, codeVendor, accountVendor, nif string — Vendor: id, name, code, ledger account and tax id.

vendorType, vendorTypeCode string, vendorTypeInternal boolean — Vendor type: name, code and whether it is internal.

locked boolean — Locked.

sentBy, receivedBy string — Who placed the order and who received it.

idCostType, costType, codeCostType, accountCostType, accountAuxCostType string — Delivery note's cost account. When assigned per line, it is on each line.

idBusinessLine, businessLine, codeBusinessLine string — Business line.

baseCalculated number — Base calculated from received lines, with 5 decimals.

base, taxes, total number — Base, taxes (including shipping, discounts and other) and total.

listTaxes array — Taxes: id, type, base, percent and total. type: 0 VAT · 1 shipping · 2 discount · 3 other.

listDeliveries array — Received lines.

listSent array — Lines of the order as sent.

id string — Line id. position integer — Order.

idComponent, component, codeComponent string — Product: id, name and code.

codeVendorComponent string — Vendor's product code.

comment string — Comment.

quantity number, idUnit, unit string — Quantity in the product's base unit.

cost number — Cost per base unit. Line amount: quantity × cost.

hasFormat boolean — Whether it was bought in a format (e.g. boxes).

quantityFormat number, idUnitFormat, unitFormat string, costFormat number — Format: quantity, unit and price per format. null if hasFormat is false.

idStore, store string — Store.

iva number — VAT %.

idCostType, costType, codeCostType, accountCostType, accountAuxCostType string — Line's cost account.

idBusinessLine, businessLine, codeBusinessLine string — Line's business line.

listTypes array — Product families: id and descr.

recibido boolean — Always true.

idCustomer string · optional — Only invoices for this customer.

id string — Invoice id.

invoiceNum string — Invoice number.

documentNum string — Document number.

date, dateAccounting, dateDue date — Invoice date, accounting date (if null, use date) and due date.

createdAt, updatedAt date — Created and last updated.

idCustomer, customer, codeCustomer, accountCustomer, nif string — Customer: id, name, code, ledger account and tax id.

paid, locked boolean — Paid and locked.

comment string — Comment.

codePaymentType string — Payment method code.

idCostTypeVendor, costTypeVendor, codeCostTypeVendor, accountCostTypeVendor, accountAuxCostTypeVendor string — Customer's default cost account: id, name, code, ledger account and auxiliary account.

idDocument, extDocument string — Attached document: id and extension.

base, taxes, total number — Tax base, taxes and total.

listTaxes array — Taxes: id, type, base, percent and total. type: 0 VAT · 1 shipping · 2 discount · 3 other.

listCostTypeTaxes array — VAT by cost account, calculated from sent lines: account id and descr (null if the lines have none) and listTaxes (type, base, percent, total).

listDeliveries array — The invoice's sales delivery notes.

id string — Delivery note id.

invoiceNum string — Delivery note number.

date date — Delivery note date.

idCustomer, customer, customerCode, nif string — Customer: id, name, code and tax id.

address, cp, city string — Customer's address, postcode and city.

contact, phone, contactAux, phoneAux, mail, mailAux, mailCC, web string — Customer contacts.

customerType, customerTypeCode string, customerTypeInternal boolean — Customer type: name, code and whether it is internal.

base number — Base of the sent lines.

listLines, listLinesPending array — Sent lines and lines pending shipment.

id string — Line id. position integer — Order within the list, from 0.

idComponent, component, codeComponent string — Product sold.

idMenu, menu, codeMenu string — Menu sold.

codeCustomerProduct string — Customer's sales code for the product.

idCustomerGroup, customerGroup string — Product group.

comment string — Comment. On lines without product or menu, the sales product name.

sent boolean — Sent.

quantity number, idUnit, unit string — Quantity and unit.

cost number — Unit sale price excluding VAT.

costRecipe number — Unit recipe cost.

iva number — VAT %.

listTypes array — Product families: id and descr.