Create one

post

https://api.cardda.com/v1/erp/payouts/payables

Creates a new payable. This endpoint skips user authentication (it can be used by
unauthenticated flows). The company is identified by the company_id field in the
request body; send the same company UUID in the required company-id header.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body required to create a payable

amount

integer

company_id

uuid

currency

string

enum

Allowed:

operation_type_id

uuid

The company's operation type ("¿Qué estás pagando?", GET /v1/erp/payouts/operation_types).
When present, the server derives document_type from the type's base behavior
(advance → 27, reimbursement → 29, other → 131 "Otro pago", whatever the receipt)
and any document_type sent is ignored. It must belong to the payable's company and not be
archived, or the request answers 422 validation/invalid_operation_type. An authenticated
request (session or API key) that sends it must also send receipt_kind.

document_typedeprecated

Legacy, used only when operation_type_id is absent: 27 (Anticipo) or 29 (Reembolso),
as a string or an integer, and the payable gets the company's default Anticipo or
Reembolso operation type; or 129 (Abono a fondo por rendir) together with
imprest_fund_id, which gets no operation type. Any other value answers 422
validation/unsupported_document_type: invoices and boletas de honorarios arrive
from the SII and are not created here. When operation_type_id is present the
value is ignored, whatever it is.

receipt_kind

string

enum

What backs the payment: Factura, Boleta, Boleta de honorarios, Nota de cobro,
Otro documento or Sin comprobante (none). Required for authenticated requests (session or API key) with
operation_type_id; otherwise optional (NULL reads "No informado").

Allowed:

receipt_folio

string

length ≤ 40

The receipt's own folio (not the internal folio). Dropped when receipt_kind is absent or none. Shown as the payable's number when it has no SII document.

counterpart_company_id

uuid

description

string

business_partner_id

uuid

The id of an existing business partner to associate with this payable.

imprest_fund_id

uuid

The id of the imprest fund this payable is charged against, if any.

payment_date

date-time

The scheduled/expected payment date for this payable.

counterpart_company

object

Nested counterpart-company attributes. Use this (not top-level fields) to create/identify the counterpart company when you don't provide a counterpart_company_id. identifier is the RUT and name the company name.

business_partner

object

Nested business-partner attributes, used to create/associate the business partner (and its underlying Person partner) inline.

custom_column_values

array of objects

Values for the company's custom columns that apply to payables (applicable_models
including tradables), set in the same request and transaction as the payable.
Optional, unless the payable is a reimbursement (document_type 29) and the company
marked some column as required (required_on_reimbursements: true on the custom
column): then every required column must end up with a value, or the reimbursement is
not created (422 validation/required_custom_column, with the missing column's label
and custom_column_id). POST /v1/erp/payouts/payables/verify_company lists those
columns.

The company is the payable's company_id. Columns of another company, or that do
not apply to payables, are ignored.
A blank value is ignored, so the column's default_value applies. A non-blank
default satisfies a required column; an empty one does not.
For an options column, value is the option key; a key outside the options
answers 422.
Only checked when the reimbursement is created: the value can be emptied or
corrected later.

custom_column_values

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Pay endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

If the deprecated company_id query parameter is also sent as a single-company selector, both
values must match; the API returns 422 Unprocessable Entity when they disagree. Endpoints whose
company_id accepts several companies document their own rules.

Responses

401

Unauthorized

Language

Loading…

Response

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

application/json

201Body of the created payable.