# Piriod Docs

## Docs

- [Authentication](https://docs.piriod.com/api-reference/authentication.md): How to authenticate requests against the Piriod API.
- [Archive addon](https://docs.piriod.com/api-reference/billing/addons/archive-addon.md)
- [Create addon](https://docs.piriod.com/api-reference/billing/addons/create-addon.md)
- [List addons](https://docs.piriod.com/api-reference/billing/addons/list-addons.md)
- [Partial update addon](https://docs.piriod.com/api-reference/billing/addons/partial-update-addon.md)
- [Retrieve addon](https://docs.piriod.com/api-reference/billing/addons/retrieve-addon.md)
- [Create contact](https://docs.piriod.com/api-reference/billing/contacts/create-contact.md)
- [Delete contact](https://docs.piriod.com/api-reference/billing/contacts/delete-contact.md)
- [List contacts](https://docs.piriod.com/api-reference/billing/contacts/list-contacts.md): Returns a paginated list of contacts. A customer is limited to seven contacts per organisation unit (or seven without an org unit).
- [Partial update contact](https://docs.piriod.com/api-reference/billing/contacts/partial-update-contact.md)
- [Retrieve contact](https://docs.piriod.com/api-reference/billing/contacts/retrieve-contact.md)
- [Archive coupon](https://docs.piriod.com/api-reference/billing/coupons/archive-coupon.md)
- [Create coupon](https://docs.piriod.com/api-reference/billing/coupons/create-coupon.md)
- [List coupons](https://docs.piriod.com/api-reference/billing/coupons/list-coupons.md)
- [Partial update coupon](https://docs.piriod.com/api-reference/billing/coupons/partial-update-coupon.md)
- [Retrieve coupon](https://docs.piriod.com/api-reference/billing/coupons/retrieve-coupon.md)
- [Create credit note (draft)](https://docs.piriod.com/api-reference/billing/creditnotes/create-credit-note-draft.md): Creates a credit note. If the related invoice or chosen document allows partial credit, the line totals are computed from the request; otherwise the lines mirror the invoice.
- [Delete credit note (draft only)](https://docs.piriod.com/api-reference/billing/creditnotes/delete-credit-note-draft-only.md)
- [Finalize credit note](https://docs.piriod.com/api-reference/billing/creditnotes/finalize-credit-note.md): Submits the credit note to the tax agency (when applicable) and locks the document.
- [List credit notes](https://docs.piriod.com/api-reference/billing/creditnotes/list-credit-notes.md)
- [Partial update credit note (draft only)](https://docs.piriod.com/api-reference/billing/creditnotes/partial-update-credit-note-draft-only.md)
- [Render credit-note PDF](https://docs.piriod.com/api-reference/billing/creditnotes/render-credit-note-pdf.md)
- [Retrieve credit note](https://docs.piriod.com/api-reference/billing/creditnotes/retrieve-credit-note.md)
- [Create customer](https://docs.piriod.com/api-reference/billing/customers/create-customer.md)
- [Delete customer](https://docs.piriod.com/api-reference/billing/customers/delete-customer.md): Soft-archives the customer (sets `status=archived`) when there are non-draft invoices, terminal subscriptions, valuable sources, or abandoned sources with payments. Otherwise hard-deletes the customer and any draft invoices.
- [List customers](https://docs.piriod.com/api-reference/billing/customers/list-customers.md): Returns a paginated list of customers in the workspace.
- [Partial update customer](https://docs.piriod.com/api-reference/billing/customers/partial-update-customer.md)
- [Retrieve customer](https://docs.piriod.com/api-reference/billing/customers/retrieve-customer.md)
- [Create debit note](https://docs.piriod.com/api-reference/billing/debitnotes/create-debit-note.md)
- [Delete debit note](https://docs.piriod.com/api-reference/billing/debitnotes/delete-debit-note.md)
- [List debit notes](https://docs.piriod.com/api-reference/billing/debitnotes/list-debit-notes.md)
- [Partial update debit note](https://docs.piriod.com/api-reference/billing/debitnotes/partial-update-debit-note.md)
- [Retrieve debit note](https://docs.piriod.com/api-reference/billing/debitnotes/retrieve-debit-note.md)
- [Create invoice (draft)](https://docs.piriod.com/api-reference/billing/invoices/create-invoice-draft.md): Creates an invoice in `draft` status. Totals (`amount`, `tax`, `subtotal`, `total`) are computed server-side from the lines. Call `finalize` to issue the invoice to the tax agency and lock it.
- [Delete invoice (draft only)](https://docs.piriod.com/api-reference/billing/invoices/delete-invoice-draft-only.md): Only invoices in `draft` status can be deleted. Linked payments are unlinked.
- [Finalize invoice](https://docs.piriod.com/api-reference/billing/invoices/finalize-invoice.md): Submits the invoice to the tax agency (when applicable) and locks the document. Requires status `draft` or `pending`. When status is `pending` all linked payments must be `succeeded`.
- [List invoices](https://docs.piriod.com/api-reference/billing/invoices/list-invoices.md): Returns a paginated list of invoices. The list excludes draft invoices that belong to a subscription, and (unless filtered by `bulk`) invoices attached to a bulk in `pending`, `processing` or `failed` status.
- [Partial update invoice (draft only)](https://docs.piriod.com/api-reference/billing/invoices/partial-update-invoice-draft-only.md)
- [Render invoice PDF](https://docs.piriod.com/api-reference/billing/invoices/render-invoice-pdf.md): Returns the invoice PDF. Uses the fiscal format when the document type has a local biller; otherwise renders a plain HTML-to-PDF template.
- [Retrieve invoice](https://docs.piriod.com/api-reference/billing/invoices/retrieve-invoice.md)
- [Toggle uncollectible](https://docs.piriod.com/api-reference/billing/invoices/toggle-uncollectible.md): Toggles the invoice between `finalized` and `uncollectible`. Sets or clears the `uncollectible` timestamp accordingly.
- [Create org unit](https://docs.piriod.com/api-reference/billing/orgunits/create-org-unit.md)
- [Delete org unit](https://docs.piriod.com/api-reference/billing/orgunits/delete-org-unit.md): Refuses to delete when there are linked contacts or subscriptions; remove them first.
- [List organisation units](https://docs.piriod.com/api-reference/billing/orgunits/list-organisation-units.md): Returns a paginated list of organisation units. A customer can have at most twelve org units; org units are an optional sub-grouping for contacts and subscriptions.
- [Partial update org unit](https://docs.piriod.com/api-reference/billing/orgunits/partial-update-org-unit.md)
- [Retrieve org unit](https://docs.piriod.com/api-reference/billing/orgunits/retrieve-org-unit.md)
- [Create payment receipt (draft)](https://docs.piriod.com/api-reference/billing/payment-receipts/create-payment-receipt-draft.md)
- [Delete payment receipt (draft only)](https://docs.piriod.com/api-reference/billing/payment-receipts/delete-payment-receipt-draft-only.md)
- [Finalize payment receipt](https://docs.piriod.com/api-reference/billing/payment-receipts/finalize-payment-receipt.md)
- [List payment receipts](https://docs.piriod.com/api-reference/billing/payment-receipts/list-payment-receipts.md)
- [Partial update payment receipt (draft only)](https://docs.piriod.com/api-reference/billing/payment-receipts/partial-update-payment-receipt-draft-only.md)
- [Retrieve payment receipt](https://docs.piriod.com/api-reference/billing/payment-receipts/retrieve-payment-receipt.md)
- [Archive plan](https://docs.piriod.com/api-reference/billing/plans/archive-plan.md)
- [Create plan](https://docs.piriod.com/api-reference/billing/plans/create-plan.md)
- [List plans](https://docs.piriod.com/api-reference/billing/plans/list-plans.md)
- [Partial update plan (mutable fields)](https://docs.piriod.com/api-reference/billing/plans/partial-update-plan-mutable-fields.md)
- [Retrieve plan](https://docs.piriod.com/api-reference/billing/plans/retrieve-plan.md)
- [Archive product](https://docs.piriod.com/api-reference/billing/products/archive-product.md): Soft-deletes the product (sets `status=archived`). Cannot be reused after archive.
- [Create product](https://docs.piriod.com/api-reference/billing/products/create-product.md)
- [List products](https://docs.piriod.com/api-reference/billing/products/list-products.md)
- [Partial update product](https://docs.piriod.com/api-reference/billing/products/partial-update-product.md)
- [Retrieve product](https://docs.piriod.com/api-reference/billing/products/retrieve-product.md)
- [Cancel subscription](https://docs.piriod.com/api-reference/billing/subscriptions/cancel-subscription.md): If the subscription has no non-draft invoices it is hard-deleted; otherwise it is cancelled (`status=cancelled`, `cancelled` timestamp set) and a `cancel_reason` is recorded (defaults to `not_specified`).
- [Create subscription](https://docs.piriod.com/api-reference/billing/subscriptions/create-subscription.md)
- [List subscriptions](https://docs.piriod.com/api-reference/billing/subscriptions/list-subscriptions.md)
- [Partial update subscription](https://docs.piriod.com/api-reference/billing/subscriptions/partial-update-subscription.md)
- [Pause subscription](https://docs.piriod.com/api-reference/billing/subscriptions/pause-subscription.md)
- [Resume subscription](https://docs.piriod.com/api-reference/billing/subscriptions/resume-subscription.md)
- [Retrieve subscription](https://docs.piriod.com/api-reference/billing/subscriptions/retrieve-subscription.md)
- [List usages](https://docs.piriod.com/api-reference/billing/usages/list-usages.md)
- [Record usage](https://docs.piriod.com/api-reference/billing/usages/record-usage.md)
- [List exchange rates](https://docs.piriod.com/api-reference/collections/generals/changes/list-exchange-rates.md): Historical exchange rates between currencies.
- [List countries](https://docs.piriod.com/api-reference/collections/generals/countries/list-countries.md): Reference catalogue of supported countries.
- [List currencies](https://docs.piriod.com/api-reference/collections/generals/currencies/list-currencies.md): Reference catalogue of currencies. Public endpoint — does not require authentication or workspace headers.
- [List document types](https://docs.piriod.com/api-reference/collections/generals/documents/list-document-types.md): Reference catalogue of fiscal document types per country.
- [List document reference types](https://docs.piriod.com/api-reference/collections/generals/references/list-document-reference-types.md): Reference catalogue of document-reference types (used to link an invoice to a previous document, e.g. credit notes).
- [List states / provinces](https://docs.piriod.com/api-reference/collections/generals/states/list-states-provinces.md)
- [Error handling](https://docs.piriod.com/api-reference/error-handling.md): Status codes and response shapes when something goes wrong.
- [Integration flows](https://docs.piriod.com/api-reference/integration-flows.md): End-to-end scenarios for the most common Piriod use cases.
- [Introduction](https://docs.piriod.com/api-reference/introduction.md): Welcome to the Piriod API.
- [Pagination and filtering](https://docs.piriod.com/api-reference/pagination-filtering.md): Working with list endpoints: pagination, filters, ordering and search.
- [Create ACH adjustment](https://docs.piriod.com/api-reference/payments/ach_transfers/adjustments/create-ach-adjustment.md)
- [Delete ACH adjustment](https://docs.piriod.com/api-reference/payments/ach_transfers/adjustments/delete-ach-adjustment.md): Reverses the adjustment on the parent transfer. The transfer must be `pending`.
- [List ACH adjustments](https://docs.piriod.com/api-reference/payments/ach_transfers/adjustments/list-ach-adjustments.md)
- [Archive ACH transfer](https://docs.piriod.com/api-reference/payments/ach_transfers/archive-ach-transfer.md): Archives the transfer (status `pending` only). Sets `status=archived` and an `archived` timestamp.
- [List ACH transfers](https://docs.piriod.com/api-reference/payments/ach_transfers/list-ach-transfers.md): Lists ACH transfers. By default, archived transfers are excluded; pass `status=archived` to include them.
- [Retrieve ACH transfer](https://docs.piriod.com/api-reference/payments/ach_transfers/retrieve-ach-transfer.md)
- [Create boleto](https://docs.piriod.com/api-reference/payments/boletos/create-boleto.md)
- [Delete boleto](https://docs.piriod.com/api-reference/payments/boletos/delete-boleto.md)
- [List boletos](https://docs.piriod.com/api-reference/payments/boletos/list-boletos.md)
- [Retrieve boleto](https://docs.piriod.com/api-reference/payments/boletos/retrieve-boleto.md)
- [Authorize payment (publishable)](https://docs.piriod.com/api-reference/payments/payments/authorize-payment-publishable.md): Public endpoint used during a checkout flow. Attaches a `source` to the payment and authorizes the gateway transaction. Does **not** require authentication; the payment is found by its ID alone, so its `enable_checkout` flag must be `true`.
- [Create payment](https://docs.piriod.com/api-reference/payments/payments/create-payment.md)
- [Delete payment](https://docs.piriod.com/api-reference/payments/payments/delete-payment.md): Refuses to delete payments in `succeeded` or `processing` status, or payments linked to an invoice.
- [List payments](https://docs.piriod.com/api-reference/payments/payments/list-payments.md)
- [Retrieve payment](https://docs.piriod.com/api-reference/payments/payments/retrieve-payment.md)
- [Create refund](https://docs.piriod.com/api-reference/payments/refunds/create-refund.md): Issues a refund against a payment. The total of refund amounts cannot exceed the payment's amount.
- [Create source (publishable)](https://docs.piriod.com/api-reference/payments/sources/create-source-publishable.md): Creates a payment source. This endpoint accepts unauthenticated calls from the browser (publishable flow), so the request is identified by the gateway/customer/payment context rather than a workspace header.
- [Delete or finalize source](https://docs.piriod.com/api-reference/payments/sources/delete-or-finalize-source.md): For reusable sources: detaches the tokenization at the gateway and either finalizes the source (when it has linked payments) or hard- deletes it. For single-use sources tied to ACH transfers, releases the balance back to the transfer. Refuses to delete other single-use sources.
- [List sources](https://docs.piriod.com/api-reference/payments/sources/list-sources.md)
- [Retrieve source](https://docs.piriod.com/api-reference/payments/sources/retrieve-source.md)
- [Create cancellation](https://docs.piriod.com/api-reference/procurement/cancellations/create-cancellation.md)
- [List cancellations](https://docs.piriod.com/api-reference/procurement/cancellations/list-cancellations.md)
- [Retrieve cancellation](https://docs.piriod.com/api-reference/procurement/cancellations/retrieve-cancellation.md)
- [Create order (draft)](https://docs.piriod.com/api-reference/procurement/orders/create-order-draft.md)
- [Delete order](https://docs.piriod.com/api-reference/procurement/orders/delete-order.md)
- [Finalize order](https://docs.piriod.com/api-reference/procurement/orders/finalize-order.md)
- [List orders](https://docs.piriod.com/api-reference/procurement/orders/list-orders.md)
- [Partial update order](https://docs.piriod.com/api-reference/procurement/orders/partial-update-order.md)
- [Render order PDF](https://docs.piriod.com/api-reference/procurement/orders/render-order-pdf.md)
- [Retrieve order](https://docs.piriod.com/api-reference/procurement/orders/retrieve-order.md)
- [Create purchase (draft)](https://docs.piriod.com/api-reference/procurement/purchases/create-purchase-draft.md)
- [Create purchase credit note (draft)](https://docs.piriod.com/api-reference/procurement/purchases/credit-notes/create-purchase-credit-note-draft.md)
- [Delete purchase credit note (draft only)](https://docs.piriod.com/api-reference/procurement/purchases/credit-notes/delete-purchase-credit-note-draft-only.md)
- [Finalize purchase credit note](https://docs.piriod.com/api-reference/procurement/purchases/credit-notes/finalize-purchase-credit-note.md)
- [List purchase credit notes](https://docs.piriod.com/api-reference/procurement/purchases/credit-notes/list-purchase-credit-notes.md)
- [Partial update purchase credit note (draft only)](https://docs.piriod.com/api-reference/procurement/purchases/credit-notes/partial-update-purchase-credit-note-draft-only.md)
- [Render purchase credit-note PDF](https://docs.piriod.com/api-reference/procurement/purchases/credit-notes/render-purchase-credit-note-pdf.md)
- [Retrieve purchase credit note](https://docs.piriod.com/api-reference/procurement/purchases/credit-notes/retrieve-purchase-credit-note.md)
- [Delete purchase (draft only)](https://docs.piriod.com/api-reference/procurement/purchases/delete-purchase-draft-only.md)
- [Finalize purchase](https://docs.piriod.com/api-reference/procurement/purchases/finalize-purchase.md): Submits the purchase to the tax agency (when applicable) and locks it.
- [List purchases](https://docs.piriod.com/api-reference/procurement/purchases/list-purchases.md)
- [Partial update purchase (draft only)](https://docs.piriod.com/api-reference/procurement/purchases/partial-update-purchase-draft-only.md)
- [Render purchase PDF](https://docs.piriod.com/api-reference/procurement/purchases/render-purchase-pdf.md)
- [Retrieve purchase](https://docs.piriod.com/api-reference/procurement/purchases/retrieve-purchase.md)
- [Create retention (draft)](https://docs.piriod.com/api-reference/procurement/retentions/create-retention-draft.md)
- [Delete retention (draft only)](https://docs.piriod.com/api-reference/procurement/retentions/delete-retention-draft-only.md)
- [Finalize retention](https://docs.piriod.com/api-reference/procurement/retentions/finalize-retention.md)
- [List retentions](https://docs.piriod.com/api-reference/procurement/retentions/list-retentions.md)
- [Partial update retention (draft only)](https://docs.piriod.com/api-reference/procurement/retentions/partial-update-retention-draft-only.md)
- [Render retention PDF](https://docs.piriod.com/api-reference/procurement/retentions/render-retention-pdf.md)
- [Retrieve retention](https://docs.piriod.com/api-reference/procurement/retentions/retrieve-retention.md)
- [Create supplier](https://docs.piriod.com/api-reference/procurement/suppliers/create-supplier.md)
- [Delete supplier](https://docs.piriod.com/api-reference/procurement/suppliers/delete-supplier.md)
- [List suppliers](https://docs.piriod.com/api-reference/procurement/suppliers/list-suppliers.md)
- [Partial update supplier](https://docs.piriod.com/api-reference/procurement/suppliers/partial-update-supplier.md)
- [Retrieve supplier](https://docs.piriod.com/api-reference/procurement/suppliers/retrieve-supplier.md)
- [Crear complemento de pago](https://docs.piriod.com/developers/api-templates/mx-create-payment-complement.md)
- [Overview](https://docs.piriod.com/developers/api-templates/overview.md)
- [Recursos para desarrolladores](https://docs.piriod.com/developers/overview.md)
- [Crear un webhook](https://docs.piriod.com/developers/webhooks/crear-un-webhook.md): Conoce cómo escribir el código para manejar las notificaciones al webhook.
- [Recibe notificaciones de eventos en tiempo real con webhooks ](https://docs.piriod.com/developers/webhooks/overview.md): Los webhooks de Piriod notifican a tu servicio cuando cambian los clientes, las facturas, los pagos o las suscripciones. Configura un endpoint y regístralo en dos pasos.
- [ Registrar un webhook](https://docs.piriod.com/developers/webhooks/registrar-un-webhook.md): Registra la URL del endpoint de tu servicio en Piriod, selecciona los eventos a los que deseas suscribirlo y gestiona su activación, desactivación o eliminación desde el dashboard.
- [Verificar firma](https://docs.piriod.com/developers/webhooks/verificar-firma.md): Confirms que las solicitudes de webhook son auténticas calculando una firma HMAC-SHA256 con tu secreto de endpoint y comparándola con el encabezado x-piriod-signature.
- [Introducción a Piriod](https://docs.piriod.com/guia/comenzar/introduccion-a-piriod.md)
- [Signup Forms](https://docs.piriod.com/guia/componentes/signup-forms.md)
- [Clientes](https://docs.piriod.com/guia/contactos/clientes.md)
- [Personas](https://docs.piriod.com/guia/contactos/personas.md)
- [Facturas](https://docs.piriod.com/guia/facturacion/facturas.md)
- [Notas De Credito](https://docs.piriod.com/guia/facturacion/notas-de-credito.md)
- [Ordenes](https://docs.piriod.com/guia/facturacion/ordenes.md)
- [Cuentas Por Cobrar](https://docs.piriod.com/guia/ingresos/cuentas-por-cobrar.md)
- [Pagos Externos](https://docs.piriod.com/guia/ingresos/pagos-externos.md)
- [Comprobante De Pago](https://docs.piriod.com/guia/ingresos/pagos/comprobante-de-pago.md)
- [Pagos](https://docs.piriod.com/guia/ingresos/pagos/pagos.md)
- [Tarjetas](https://docs.piriod.com/guia/ingresos/tarjetas.md)
- [Transferencias](https://docs.piriod.com/guia/ingresos/transferencias.md)
- [Complementos](https://docs.piriod.com/guia/suscripciones/complementos.md)
- [Cupones De Descuento](https://docs.piriod.com/guia/suscripciones/cupones-de-descuento.md)
- [Facturas recurrentes](https://docs.piriod.com/guia/suscripciones/facturas-recurrentes.md)
- [Introducción a planes](https://docs.piriod.com/guia/suscripciones/planes/introduccion.md)
- [Por Paquete](https://docs.piriod.com/guia/suscripciones/planes/por-paquete.md)
- [Por Paquete Con Excedente](https://docs.piriod.com/guia/suscripciones/planes/por-paquete-con-excedente.md)
- [Por Volumen](https://docs.piriod.com/guia/suscripciones/planes/por-volumen.md)
- [Por Volumen Gradual](https://docs.piriod.com/guia/suscripciones/planes/por-volumen-gradual.md)
- [Precio Fijo](https://docs.piriod.com/guia/suscripciones/planes/precio-fijo.md)
- [Productos](https://docs.piriod.com/guia/suscripciones/productos.md)

## OpenAPI Specs

- [openapi](https://docs.piriod.com/openapi.json)