Skip to main content
A Payment Batch (Nómina in the app) is a set of payments an Entity sends to its bank together, on one payment date. A batch names no paying account: you choose the Bank Account a bank file pays from when you download the file, because orders in other currencies don’t leave from it. Each line of a batch is a Payment Order (Pago): it pays a purchase Invoice, or it’s a manual payment with no document. Each Payment Order states its own currency. An order that pays an Invoice is in the Invoice’s currency. A manual order is in the currency you choose. One batch can mix currencies, so it totals each currency apart and converts nothing. The bank files carry only the orders in CLP. You pay an order in another currency at the bank by hand, such as a USD payment to a foreign vendor. It still counts in the batch’s totals and appears in the movements spreadsheet. Its payee needs no Chilean RUT and no Bank Details. A Payment Order records what you intend to pay. It posts nothing to the ledger. The ledger stays the record of what was actually paid: once the bank executes the transfers, book or match the resulting Bank Movements as usual. When Erwin reconciles, he reads the Ready batches whose payment date is near a Movement’s date to tell who the payment is for and which Invoice it pays. He never matches a Movement that disagrees with the batch, and he ignores Drafts. Use Payment Batches to prepare a supplier payment run:
  1. List the Payables to Plan: the purchase invoices the Entity still owes.
  2. Create a Draft with the payment date. Optionally give it a name and a label.
  3. Add invoices and manual payments, and adjust amounts or memos. In the app, Agregar cuentas por pagar lists the payables in every currency and lets you search them by payee, document number, or Amount to Plan. Its Fuente selector and Filtros menu work as in Compras; see Orders in the app.
  4. Mark it Ready. This freezes the batch.
  5. Download the bank file in the app, choosing the bank and, for BCI, the account to debit. Upload it to your bank’s or Global66’s portal.
Every route on this page lives under /api/entities/:entityId/payment-batches. Amounts are integers in the minor units of their currency.
Open in the app. This resource has a page in the Sintropix web app at https://app.sintropix.com/{entityId}/payment-batches/{paymentBatchId}, where each id in braces is the same UUID as in the API route or response. /{entityId}/payment-batches lists every batch. When you mention a record to a user, include that link. See Link to the App for the full URL grammar.

Draft and Ready

A batch has two states: A batch starts as a Draft and becomes Ready only through POST /mark-ready. To fix a mistake in a Ready batch, reopen it: it becomes a Draft again, and you mark it Ready again when it’s fixed. A Ready batch can’t be deleted; reopen it first.

Name and label

A batch can carry a name and a label to tell it apart from the others. Both are optional free text:
  • Name (Nombre): up to 120 characters, such as Proveedores segunda quincena. In the app, it names the batch in the breadcrumb at the top of its page. A batch with no name is named Nómina del followed by its payment date.
  • Label (Etiqueta): up to 60 characters, such as Proveedores or Remuneraciones. Use it to group batches of the same kind. You choose the labels; Sintropix has no fixed list.
Sintropix trims both. A blank name or label is refused with 400; send null to clear it. Neither is part of the payment: no bank file carries them, and you can change them on a Ready batch. In the app:
  • Crear nómina asks for the name, the payment date, and the label. Click the batch’s name in the breadcrumb to rename it, and click its label, or Agregar etiqueta, to change it.
  • You pick a label like a tag. The picker lists the labels already used on the Entity’s batches, and Buscar o crear etiqueta… filters them as you type. To make a new label, type it and choose Crear «…». The app doesn’t offer to create a label that already exists with different capitalization, so one label isn’t spelled two ways. Choose Sin etiqueta to clear the label.
  • The Nóminas list shows each batch’s Nombre and Etiqueta. Buscar nóminas matches the name and the label. It ignores case and accents, and every word you type must match. Under Filtros, Etiqueta keeps only the batches with that exact label.

Amount to Plan

The Amount to Plan of a purchase invoice is what it still owes minus what Payment Orders already plan for it, in the Invoice’s currency:
  • An unbooked invoice owes its total. A booked invoice owes the Open Amount of its Control Line.
  • Every order that names the invoice counts, in every batch, Draft or Ready.
  • An invoice excluded from the books owes nothing, so it has nothing to plan.
Editing an order can plan more than the invoice owes. Sintropix accepts it, and the invoice’s Amount to Plan goes below zero. The app flags it as a warning.
If you match a partial payment of an invoice that a batch already plans, its Amount to Plan can show less than it still owes. Correct the order’s amount in the Draft. The books aren’t affected.

Orders in the app

The batch’s table shows, for each order that pays an invoice: A manual order shows — under Monto total and Saldo pendiente. Lowering Pago doesn’t change the other two columns. Agregar cuentas por pagar shows the same Monto total and Saldo pendiente for each invoice. When orders in other batches already plan part of the balance, a line such as $150.000 ya en nóminas shows how much. Picking the invoice adds an order for what is left, its Amount to Plan. To narrow the list, use Filtros, as on Compras. It filters by Fuente (the invoices of one Source), Documento tributario, Contacto, Moneda, Estado de pago, Estado SII, Seguimiento, issue and due dates, Período tributario, Monto, and Conversación (whether the invoice has an ERP Thread in the Chat). Each active filter shows as a chip you can remove. A due-date filter keeps the invoices with no due date. The API takes the same filters on Payables to Plan.

The Payment Batch object

Every route on this page except the list returns the batch with its orders. Each element of paymentOrders:

GET /payment-batches

List every Payment Batch of the Entity, the latest payment date first. Response: an array of Payment Batch objects without paymentOrders.

GET /payment-batches/:paymentBatchId

Read one batch with its orders. Response: the Payment Batch object.

POST /payment-batches

Create an empty Draft. Body Unknown fields, such as bankAccountId, are refused with 400. A batch names no paying account. Response (201): the Payment Batch object, with no orders.

PATCH /payment-batches/:paymentBatchId

Change the payment date of a Draft, or the name or the label of any batch. Body: at least one of the fields below. On a Ready batch, a body with paymentDate is refused with 409 and PAYMENT_BATCH_READY_ERROR, and nothing changes. A body with only name or label goes through. Response: the Payment Batch object.

DELETE /payment-batches/:paymentBatchId

Delete a Draft and its orders. A Ready batch can’t be deleted: reopen it first. Response: the Payment Batch object as it was before deletion, with its orders.

POST /payment-batches/:paymentBatchId/invoice-payment-orders

Add purchase invoices to a Draft. Each invoice becomes an order for its current Amount to Plan, in the Invoice’s currency, paid to the Invoice’s Partner. The order starts with the Invoice’s memo as its glosa, so an Expense Rendition carries the claim’s memo. An Invoice with no memo, such as most SII invoices, gives an order with none. Invoices in any currency can join the same batch. Body Each invoice must be a Payable to Plan of the batch:
  • A payable Invoice of kind invoice. A credit note, a tax_only document, or a receivable is refused with PAYMENT_ORDER_INVOICES_NOT_PAYABLE_ERROR.
  • With an Amount to Plan above zero. Otherwise PAYMENT_ORDER_INVOICES_NOTHING_TO_PLAN_ERROR.
Each of these errors answers 409 and lists every offending invoice in params.invoiceIds, so you can fix them all in one pass. Nothing is added when any invoice is refused. Response (201): the Payment Batch object.

POST /payment-batches/:paymentBatchId/payment-orders

Add a manual order, with no Invoice, to a Draft. Use it for a payment that no document backs yet, such as an advance, or a payment to a foreign vendor whose invoice comes after the payment. In the app, Agregar pago manual has a Nuevo contacto button next to Beneficiario. Use it when the payee doesn’t exist yet. It creates the Partner and selects it as the payee. If another Partner of the Organization already has that tax ID, it offers Usar with that Partner’s name instead. The Moneda starts as the Entity’s currency. Body Response (201): the Payment Batch object.

PATCH /payment-batches/:paymentBatchId/payment-orders/:paymentOrderId

Edit an order of a Draft. Body: at least one of the fields below. Response: the Payment Batch object.

DELETE /payment-batches/:paymentBatchId/payment-orders/:paymentOrderId

Remove an order. This works on a Draft and on a Ready batch, so you can take out a payment the bank rejected. Removing an order returns its amount to the invoice’s Amount to Plan. Response: the Payment Batch object.

POST /payment-batches/:paymentBatchId/mark-ready

Mark a Draft Ready. No body. The batch must have at least one order, and every payee of an order in CLP needs a Chilean RUT and Bank Details, because the bank file names each payee by them. The payee of an order in another currency needs neither. Each answers 409. Fix the Partners and try again. A Draft can hold a payee that lacks them. In the app, the row of an order in CLP flags a missing RUT or missing Bank Details. The row of an order in another currency shows the payee’s foreign tax id as is, without a warning. Once Ready, the batch keeps its payment date, takes no new order, and its orders keep their amount. Its name and label can still change. Response (200): the Payment Batch object, with readyAt and readyBy set.

POST /payment-batches/:paymentBatchId/reopen

Return a Ready batch to Draft, to fix a mistake found after it was marked Ready, such as a wrong amount or payment date. No body. The batch becomes a Draft again: readyAt and readyBy go back to null. You can then add, edit, and remove orders, change the payment date, or delete the batch. To download a bank file again, mark it Ready again, which checks the payees’ RUT and Bank Details anew. Reopening a Draft changes nothing and answers the batch as it is, so a retry is safe.
Reopening a batch doesn’t reach the bank. If you already uploaded its file to your bank’s or Global66’s portal, those transfers are unchanged. Fix or cancel them in the portal, then upload a new file if you need one.
In the app, a Ready batch shows Volver a borrador. It asks you to confirm before reopening the batch. Response (200): the Payment Batch object.

Download the bank file

In the app, a Ready batch has a Descargar menu with two options. The browser builds each file from the batch, so the API has no download route.
  • Nómina para pago nacional (CLP)…: the batch’s transfers in CLP, in the format of the bank that pays them. It opens a dialog where you choose the Banco. The dialog starts on a bank where the Entity holds a Bank Account in CLP, read from each account’s bankCode:
    • BCI: BCI’s bulk transfer file (Pago a Proveedores), in .xlsx, ready to upload to BCI’s portal. Choose the Cuenta de cargo, the account BCI debits, among the Entity’s Bank Accounts in CLP at BCI, the ones whose bankCode is 016. It needs an accountNumber. When the Entity has no such account, the dialog says La entidad legal no tiene una cuenta BCI en CLP. and links to Cuentas bancarias, where you set an account’s bank. When the chosen account has no accountNumber, the dialog names the account and links to its edit. The file carries only the orders in CLP. When the batch also has orders in other currencies, the dialog says how many are left out, for example 1 pago en otra moneda queda fuera. With no order in CLP, no BCI account in CLP, or a Cuenta de cargo with no accountNumber, Descargar is disabled and the dialog says why.
    • Global66: Global66’s beneficiary template (PlantillaBeneficiarios), filled in, as nomina-global66-<paymentDate>.xlsm, ready to upload to Global66’s portal to pay from a Global66 account. It asks for no account. It carries only the orders in CLP to a bank that Global66 lists (see Global66 file). When the batch has other orders, the dialog lists them under Estos pagos quedan fuera del archivo. Págalos por otro banco o a mano., each with its reason: an order in another currency, or a bank Global66 doesn’t transfer to. When no order qualifies, Descargar is disabled.
  • Excel de movimientos: a spreadsheet of every order, in every currency.
Every download reads the batch again first. If it was reopened in the meantime, for example from another tab, the app refuses to build the file and asks you to mark it Ready again. A bank file never carries amounts the batch no longer plans. Pay the orders a file leaves out through another channel, such as your bank’s portal.

BCI file

Each order in CLP fills one row of the BCI file:

Global66 file

Each qualifying order fills one row of the Cuenta Bancaria sheet of Global66’s template, from row 5. The template keeps its macros, validations, and other sheets. Its ¿Válido? column checks each row when you run the template’s macro, before you upload it. Global66 takes transfers to these banks, named by their CMF code: Banco de Chile (001), Banco Internacional (009), BancoEstado (012), Scotiabank (014), BCI / MACHBANK (016), Banco Bice (028), HSBC (031), Santander (037), Itaú (039), JP Morgan (041), Banco Security (049), Banco Falabella (051), Banco Ripley (053), Banco Consorcio (055), Tanner (062), Coopeuch / Dale (672), Prepago Los Héroes (729), Prepago Tenpo (730), TAPP Caja Los Andes (732), Copec Pay (741), Prex (743), Fintual (746), Fintoc (764), and Mercado Pago (875). An order to any other bank is left out of the file. Each file reads each payee’s Bank Details when you download it. If you change a Partner’s Bank Details after marking the batch Ready, download the file again.

Status codes