Gestiono
Referencia de APIAccounting / Pending Record

Create Pending Record

POST /v1/record/pending • validated by `postPendingRecord`

← Back to full API reference
POST/v1/record/pendingAuthentication required

A pending record refers to documents (invoice, quote, order, loan) that can later be linked to records such as payments, credits, and accounting movements.

  • Requires organization permissions for this resource.
  • Validated by Zod schema: postPendingRecord.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • description

    Type: string

  • notes

    Type: string

  • reference

    Type: string

  • sourcePendingRecordId

    Type: number

  • divisionId (required)

    Type: number

  • beneficiaryId

    Type: number

  • contact

    Type: object

  • contact.name (required)

    Type: string

  • contact.type (required)

    Enum-like validator generated by zodFromObj

  • contact.taxId

    Type: string

  • contact.reference

    Type: string

  • contact.labels

    Type: array

    Example:

  • contact.labels[] (required)

    Type: string

  • contact.contact

    Type: array

    Example:

  • contact.contact[] (required)

    Type: object

  • contact.contact[].type (required)

    Type: string

  • contact.contact[].data (required)

    Type: string

  • contact.contact[].dataType

    Type: enum

    Example: string

  • contact.lat

    Type: number

  • contact.lon

    Type: number

  • contact.metadata

    Type: object

  • contact.metadata.adquisitionChannel

    Type: string

  • contact.creditLimit

    Type: number

  • soldBy

    Type: number

  • type (required)

    Type: enum

    Example: INVOICE

  • isSell (required)

    Boolean parser helper from common/utils.zBoolean

  • date

    Type: string

    Example:

  • dueDate

    Type: string

    Example:

  • currency (required)

    Enum-like validator generated by zodFromObj

  • recurrency

    Type: object

  • recurrency.isPaused

    Boolean parser helper from common/utils.zBoolean

    Example: false

  • recurrency.isCanceled

    Boolean parser helper from common/utils.zBoolean

    Example: false

  • recurrency.autoChargeEnabled

    Boolean parser helper from common/utils.zBoolean

  • recurrency.paymentMethodId

    Type: string

  • recurrency.date (required)

    Type: array

    Example:

  • recurrency.date[] (required)

    Type: number

  • recurrency.date[].month (required)

    Type: number

  • recurrency.date[].day (required)

    Type: number

  • recurrency.type (required)

    Type: enum

    Example: MONTHLY

  • recurrency.createDaysBefore

    Type: number

    Example: 3

  • recurrency.dueAfter

    Type: number

  • recurrency.repeatUntil

    Type: string

  • recurrency.inPayrollSince

    Type: string

    Example:

  • recurrency.pauseOnPastDue

    Boolean parser helper from common/utils.zBoolean

  • recurrency.updatePrices

    Boolean parser helper from common/utils.zBoolean

  • recurrency.files

    Type: array

    Example:

  • recurrency.files[] (required)

    Type: object

  • recurrency.files[].s3Key (required)

    Type: string

  • recurrency.files[].fileName (required)

    Type: string

  • createFirstInvoice

    Boolean parser helper from common/utils.zBoolean

  • generateTaxId

    Type: enum

    Example: none

  • taxId

    Type: string

    Example:

  • taxInvoiceType

    Type: number

  • isInstantDelivery

    Boolean parser helper from common/utils.zBoolean

  • updatePrices

    Boolean parser helper from common/utils.zBoolean

  • elements

    Type: array

    Example:

  • elements[] (required)

    Type: unknown

  • labels

    Type: array

    Example:

  • labels[] (required)

    Type: string

  • clientdata

    Type: object

  • metadata

    Type: unknown

  • taskId

    Type: number

  • payment

    Type: object

  • payment.paymentMethod (required)

    Type: enum

    Example: CASH

  • payment.accountId (required)

    Type: number

  • payment.amount

    Type: number

  • payment.state

    Type: enum

    Example: PENDING

  • payment.reference

    Type: string

  • payment.amountConversion

    Type: number

  • payment.receivedFrom

    Type: number

  • payment.description

    Type: string

  • payment.labels

    Type: array

    Example:

  • payment.labels[] (required)

    Type: string

  • payment.clientdata

    Type: object

  • payment.date

    Type: string

  • payment.metadata

    Type: unknown

  • credit

    Type: object

  • credit.amount (required)

    Type: number

  • credit.interest (required)

    Type: number

  • credit.period (required)

    Type: enum

    Example: DAILY

  • credit.interestType

    Type: enum

    Example: COMPOUND

  • credit.totalNumberOfPayments (required)

    Type: number

  • credit.latePaymentFee

    Type: number

    Example: 0

  • credit.latePaymentInDays

    Type: number

    Example: 3

  • credit.paymentDate (required)

    Type: number

  • credit.paymentsStartsOn

    Type: string

  • credit.pendingRecordId

    Type: number

  • credit.accountId

    Type: number

  • credit.paymentMethod

    Type: enum

    Example: CASH

  • credit.contact

    Type: array

    Example:

  • credit.contact[] (required)

    Type: object

  • credit.contact[].type (required)

    Type: string

  • credit.contact[].data (required)

    Type: string

  • credit.contact[].dataType

    Type: enum

    Example: string

  • redeem

    Type: object

  • redeem.returnId (required)

    Type: number

  • redeem.amount (required)

    Type: number

Default payloads

Path params

json
{}

Query

json
{}

Body

json
{
  "divisionId": 1,
  "type": "INVOICE",
  "isSell": true,
  "currency": "string"
}

Sample response

json
{
  "pendingRecordId": "<pendingRecordId>"
}

Test this endpoint now

Use your own credentials and execute a live request directly from this page.

1. Configure authentication for testing

You can test endpoints with signed API keys, a raw Authorization token, or browser cookies. Select one mode and fill in the required fields.

2. Select endpoint

POST/v1/record/pendingAuthentication required

Group: Accounting / Pending Record

POST /v1/record/pending • validated by `postPendingRecord`

A pending record refers to documents (invoice, quote, order, loan) that can later be linked to records such as payments, credits, and accounting movements.

  • Requires organization permissions for this resource.
  • Validated by Zod schema: postPendingRecord.

Body fields

  • description
    Type: string
  • notes
    Type: string
  • reference
    Type: string
  • sourcePendingRecordId
    Type: number
  • divisionIdrequired
    Type: number
  • beneficiaryId
    Type: number
  • contact
    Type: object
  • contact.namerequired
    Type: string
  • contact.typerequired
    Enum-like validator generated by zodFromObj
  • contact.taxId
    Type: string
  • contact.reference
    Type: string
  • contact.labels
    Type: array
    Ejemplo:
  • contact.labels[]required
    Type: string
  • contact.contact
    Type: array
    Ejemplo:
  • contact.contact[]required
    Type: object
  • contact.contact[].typerequired
    Type: string
  • contact.contact[].datarequired
    Type: string
  • contact.contact[].dataType
    Type: enum
    Ejemplo: string
  • contact.lat
    Type: number
  • contact.lon
    Type: number
  • contact.metadata
    Type: object
  • contact.metadata.adquisitionChannel
    Type: string
  • contact.creditLimit
    Type: number
  • soldBy
    Type: number
  • typerequired
    Type: enum
    Ejemplo: INVOICE
  • isSellrequired
    Boolean parser helper from common/utils.zBoolean
  • date
    Type: string
    Ejemplo:
  • dueDate
    Type: string
    Ejemplo:
  • currencyrequired
    Enum-like validator generated by zodFromObj
  • recurrency
    Type: object
  • recurrency.isPaused
    Boolean parser helper from common/utils.zBoolean
    Ejemplo: false
  • recurrency.isCanceled
    Boolean parser helper from common/utils.zBoolean
    Ejemplo: false
  • recurrency.autoChargeEnabled
    Boolean parser helper from common/utils.zBoolean
  • recurrency.paymentMethodId
    Type: string
  • recurrency.daterequired
    Type: array
    Ejemplo:
  • recurrency.date[]required
    Type: number
  • recurrency.date[].monthrequired
    Type: number
  • recurrency.date[].dayrequired
    Type: number
  • recurrency.typerequired
    Type: enum
    Ejemplo: MONTHLY
  • recurrency.createDaysBefore
    Type: number
    Ejemplo: 3
  • recurrency.dueAfter
    Type: number
  • recurrency.repeatUntil
    Type: string
  • recurrency.inPayrollSince
    Type: string
    Ejemplo:
  • recurrency.pauseOnPastDue
    Boolean parser helper from common/utils.zBoolean
  • recurrency.updatePrices
    Boolean parser helper from common/utils.zBoolean
  • recurrency.files
    Type: array
    Ejemplo:
  • recurrency.files[]required
    Type: object
  • recurrency.files[].s3Keyrequired
    Type: string
  • recurrency.files[].fileNamerequired
    Type: string
  • createFirstInvoice
    Boolean parser helper from common/utils.zBoolean
  • generateTaxId
    Type: enum
    Ejemplo: none
  • taxId
    Type: string
    Ejemplo:
  • taxInvoiceType
    Type: number
  • isInstantDelivery
    Boolean parser helper from common/utils.zBoolean
  • updatePrices
    Boolean parser helper from common/utils.zBoolean
  • elements
    Type: array
    Ejemplo:
  • elements[]required
    Type: unknown
  • labels
    Type: array
    Ejemplo:
  • labels[]required
    Type: string
  • clientdata
    Type: object
  • metadata
    Type: unknown
  • taskId
    Type: number
  • payment
    Type: object
  • payment.paymentMethodrequired
    Type: enum
    Ejemplo: CASH
  • payment.accountIdrequired
    Type: number
  • payment.amount
    Type: number
  • payment.state
    Type: enum
    Ejemplo: PENDING
  • payment.reference
    Type: string
  • payment.amountConversion
    Type: number
  • payment.receivedFrom
    Type: number
  • payment.description
    Type: string
  • payment.labels
    Type: array
    Ejemplo:
  • payment.labels[]required
    Type: string
  • payment.clientdata
    Type: object
  • payment.date
    Type: string
  • payment.metadata
    Type: unknown
  • credit
    Type: object
  • credit.amountrequired
    Type: number
  • credit.interestrequired
    Type: number
  • credit.periodrequired
    Type: enum
    Ejemplo: DAILY
  • credit.interestType
    Type: enum
    Ejemplo: COMPOUND
  • credit.totalNumberOfPaymentsrequired
    Type: number
  • credit.latePaymentFee
    Type: number
    Ejemplo: 0
  • credit.latePaymentInDays
    Type: number
    Ejemplo: 3
  • credit.paymentDaterequired
    Type: number
  • credit.paymentsStartsOn
    Type: string
  • credit.pendingRecordId
    Type: number
  • credit.accountId
    Type: number
  • credit.paymentMethod
    Type: enum
    Ejemplo: CASH
  • credit.contact
    Type: array
    Ejemplo:
  • credit.contact[]required
    Type: object
  • credit.contact[].typerequired
    Type: string
  • credit.contact[].datarequired
    Type: string
  • credit.contact[].dataType
    Type: enum
    Ejemplo: string
  • redeem
    Type: object
  • redeem.returnIdrequired
    Type: number
  • redeem.amountrequired
    Type: number

3. Prepare request payload

4. Server response

Run a request to inspect the real-time response for your environment.