CAcardda
Payable

List all

Returns a list of payables the caller can access across their permitted companies.

The deprecated company_id query parameter is still accepted and, when present, filters the results to those company id(s). The company-id header and the company_id query parameter are not compared against each other, so there is no mismatch error.

get/v1/erp/payouts/payables

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/erp/payouts/payables
  • Auth
    HTTP bearer

Query parameters

company_idstring uuid

Deprecated — pass the company UUID via the company-id HTTP header instead. See The company-id header. The backend still accepts this query parameter for backwards compatibility but new integrations should use the header exclusively.

When both this query parameter and the company-id header are present, their values must match; the API returns 422 Unprocessable Entity when they disagree. This rule applies to this single-company form; endpoints whose company_id accepts several companies document their own rules.

Parameters

#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/1 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/2 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/3 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/4 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1reviews/get/parameters/5 (unresolved $ref)

Response

Paginated list of payable that the current user has access, default 25 per page but can be modified through the _end and _start params.

idstring uuid required
source_typestring
source_idstring
amountinteger required
status'pending' | 'approved' | 'declined' | 'partially_paid' | 'paid' | 'overpaid' | 'scheduled' | 'delegated' required

Derived, read-only. There is no status column: the value is computed from review_status and payment_status on every read.

  • paid or overpaid whenever payment_status is one of those two — the payment outcome wins over the review outcome.
  • otherwise, once the payable is approved and something has been paid or scheduled, the payment_status shows through (partially_paid, scheduled, delegated).
  • otherwise the review_status (pending, approved, declined).

So approved here means "approved and nothing paid yet". Filter and sort on review_status / payment_status if you need the two axes separately.

due_datestring date-time

The date in which the payable is due.

payment_status'non_paid' | 'partially_paid' | 'paid' | 'overpaid' | 'scheduled' | 'delegated'

How much of the payable has been settled. scheduled and delegated mean the payment was handed off (scheduled at the bank, or delegated to a third party) and are not terminal.

company_idstring uuid required
issue_datestring date-time

The date in which the payable was issued.

currencystring required
document_typeinteger required

An integer representing the type of document. Refer to the document_types mapping for possible values and their corresponding document types.

sender_idstring uuid
recipient_idstring uuid
counterpart_company_idstring uuid required

The id of the counterpart company. This is the company that will receive the payment.

descriptionstring
discardedboolean

Whether the payable has been discarded or not. A discarded payable will not be obtained in the index.

partially_paid_amountinteger
paid_amountinteger

The amount that has been paid for this payable. This amount is calculated using the partially_paid_amount param, the amount of the bank transactions related to the payable and the amount of the credit notes related.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.