Gestiono
Referencia de APIAccounting / Pending Record

Create Pending Record loan

POST /v1/record/pending/loan • validated by `postLoan`

← Back to full API reference
POST/v1/record/pending/loanAuthentication 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: postLoan.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • pendingRecord (required)

    Type: object

  • pendingRecord.description

    Type: string

  • pendingRecord.notes

    Type: string

  • pendingRecord.reference

    Type: string

  • pendingRecord.sourcePendingRecordId

    Type: number

  • pendingRecord.divisionId (required)

    Type: number

  • pendingRecord.beneficiaryId

    Type: number

  • pendingRecord.contact

    Type: object

  • pendingRecord.contact.name (required)

    Type: string

  • pendingRecord.contact.type (required)

    Enum-like validator generated by zodFromObj

  • pendingRecord.contact.taxId

    Type: string

  • pendingRecord.contact.reference

    Type: string

  • pendingRecord.contact.labels

    Type: array

    Example:

  • pendingRecord.contact.labels[] (required)

    Type: string

  • pendingRecord.contact.contact

    Type: array

    Example:

  • pendingRecord.contact.contact[] (required)

    Type: object

  • pendingRecord.contact.contact[].type (required)

    Type: string

  • pendingRecord.contact.contact[].data (required)

    Type: string

  • pendingRecord.contact.contact[].dataType

    Type: enum

    Example: string

  • pendingRecord.contact.lat

    Type: number

  • pendingRecord.contact.lon

    Type: number

  • pendingRecord.contact.metadata

    Type: object

  • pendingRecord.contact.metadata.adquisitionChannel

    Type: string

  • pendingRecord.contact.creditLimit

    Type: number

  • pendingRecord.soldBy

    Type: number

  • pendingRecord.type (required)

    Type: enum

    Example: INVOICE

  • pendingRecord.isSell (required)

    Boolean parser helper from common/utils.zBoolean

  • pendingRecord.date

    Type: string

    Example:

  • pendingRecord.dueDate

    Type: string

    Example:

  • pendingRecord.currency (required)

    Enum-like validator generated by zodFromObj

  • pendingRecord.recurrency

    Type: object

  • pendingRecord.recurrency.isPaused

    Boolean parser helper from common/utils.zBoolean

    Example: false

  • pendingRecord.recurrency.isCanceled

    Boolean parser helper from common/utils.zBoolean

    Example: false

  • pendingRecord.recurrency.autoChargeEnabled

    Boolean parser helper from common/utils.zBoolean

  • pendingRecord.recurrency.paymentMethodId

    Type: string

  • pendingRecord.recurrency.date (required)

    Type: array

    Example:

  • pendingRecord.recurrency.date[] (required)

    Type: number

  • pendingRecord.recurrency.date[].month (required)

    Type: number

  • pendingRecord.recurrency.date[].day (required)

    Type: number

  • pendingRecord.recurrency.type (required)

    Type: enum

    Example: MONTHLY

  • pendingRecord.recurrency.createDaysBefore

    Type: number

    Example: 3

  • pendingRecord.recurrency.dueAfter

    Type: number

  • pendingRecord.recurrency.repeatUntil

    Type: string

  • pendingRecord.recurrency.inPayrollSince

    Type: string

    Example:

  • pendingRecord.recurrency.pauseOnPastDue

    Boolean parser helper from common/utils.zBoolean

  • pendingRecord.recurrency.updatePrices

    Boolean parser helper from common/utils.zBoolean

  • pendingRecord.recurrency.files

    Type: array

    Example:

  • pendingRecord.recurrency.files[] (required)

    Type: object

  • pendingRecord.recurrency.files[].s3Key (required)

    Type: string

  • pendingRecord.recurrency.files[].fileName (required)

    Type: string

  • pendingRecord.createFirstInvoice

    Boolean parser helper from common/utils.zBoolean

  • pendingRecord.generateTaxId

    Type: enum

    Example: none

  • pendingRecord.taxId

    Type: string

    Example:

  • pendingRecord.taxInvoiceType

    Type: number

  • pendingRecord.isInstantDelivery

    Boolean parser helper from common/utils.zBoolean

  • pendingRecord.updatePrices

    Boolean parser helper from common/utils.zBoolean

  • pendingRecord.elements

    Type: array

    Example:

  • pendingRecord.elements[] (required)

    Type: unknown

  • pendingRecord.labels

    Type: array

    Example:

  • pendingRecord.labels[] (required)

    Type: string

  • pendingRecord.clientdata

    Type: object

  • pendingRecord.metadata

    Type: unknown

  • pendingRecord.taskId

    Type: number

  • pendingRecord.payment

    Type: object

  • pendingRecord.payment.paymentMethod (required)

    Type: enum

    Example: CASH

  • pendingRecord.payment.accountId (required)

    Type: number

  • pendingRecord.payment.amount

    Type: number

  • pendingRecord.payment.state

    Type: enum

    Example: PENDING

  • pendingRecord.payment.reference

    Type: string

  • pendingRecord.payment.amountConversion

    Type: number

  • pendingRecord.payment.receivedFrom

    Type: number

  • pendingRecord.payment.description

    Type: string

  • pendingRecord.payment.labels

    Type: array

    Example:

  • pendingRecord.payment.labels[] (required)

    Type: string

  • pendingRecord.payment.clientdata

    Type: object

  • pendingRecord.payment.date

    Type: string

  • pendingRecord.payment.metadata

    Type: unknown

  • pendingRecord.credit

    Type: object

  • pendingRecord.credit.amount (required)

    Type: number

  • pendingRecord.credit.interest (required)

    Type: number

  • pendingRecord.credit.period (required)

    Type: enum

    Example: DAILY

  • pendingRecord.credit.interestType

    Type: enum

    Example: COMPOUND

  • pendingRecord.credit.totalNumberOfPayments (required)

    Type: number

  • pendingRecord.credit.latePaymentFee

    Type: number

    Example: 0

  • pendingRecord.credit.latePaymentInDays

    Type: number

    Example: 3

  • pendingRecord.credit.paymentDate (required)

    Type: number

  • pendingRecord.credit.paymentsStartsOn

    Type: string

  • pendingRecord.credit.pendingRecordId

    Type: number

  • pendingRecord.credit.accountId

    Type: number

  • pendingRecord.credit.paymentMethod

    Type: enum

    Example: CASH

  • pendingRecord.credit.contact

    Type: array

    Example:

  • pendingRecord.credit.contact[] (required)

    Type: object

  • pendingRecord.credit.contact[].type (required)

    Type: string

  • pendingRecord.credit.contact[].data (required)

    Type: string

  • pendingRecord.credit.contact[].dataType

    Type: enum

    Example: string

  • pendingRecord.redeem

    Type: object

  • pendingRecord.redeem.returnId (required)

    Type: number

  • pendingRecord.redeem.amount (required)

    Type: number

  • credit (required)

    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

Default payloads

Path params

json
{}

Query

json
{}

Body

json
{
  "pendingRecord": {
    "divisionId": 1,
    "type": "INVOICE",
    "isSell": true,
    "currency": "string"
  },
  "credit": {
    "amount": 1,
    "interest": 1,
    "period": "DAILY",
    "totalNumberOfPayments": 1,
    "paymentDate": 1
  }
}

Sample response

json
{}

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/pending/loanAuthentication required

Group: Accounting / Pending Record

POST /v1/record/pending/loan • validated by `postLoan`

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: postLoan.

Body fields

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

3. Prepare request payload

4. Server response

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

POST /v1/record/pending/bulk

Previous Page

POST /v1/record/pending/clone

Next Page