Referencia de APIAccounting / Pending Record
Create Pending Record loan
← Back to full API reference
POST
/v1/record/pending/loanAuth requiredA 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
Body fields
| Field | Required | Description |
|---|---|---|
| pendingRecord | Yes | Type: object |
| pendingRecord.description | No | Type: string |
| pendingRecord.notes | No | Type: string |
| pendingRecord.reference | No | Type: string |
| pendingRecord.sourcePendingRecordId | No | Type: number |
| pendingRecord.divisionId | Yes | Type: number |
| pendingRecord.beneficiaryId | No | Type: number |
| pendingRecord.contact | No | Type: object |
| pendingRecord.contact.name | Yes | Type: string |
| pendingRecord.contact.type | Yes | Enum-like validator generated by zodFromObj |
| pendingRecord.contact.taxId | No | Type: string |
| pendingRecord.contact.reference | No | Type: string |
| pendingRecord.contact.labels | No | Type: arrayExample: |
| pendingRecord.contact.labels[] | Yes | Type: string |
| pendingRecord.contact.contact | No | Type: arrayExample: |
| pendingRecord.contact.contact[] | Yes | Type: object |
| pendingRecord.contact.contact[].type | Yes | Type: string |
| pendingRecord.contact.contact[].data | Yes | Type: string |
| pendingRecord.contact.contact[].dataType | No | Type: enumExample: string |
| pendingRecord.contact.lat | No | Type: number |
| pendingRecord.contact.lon | No | Type: number |
| pendingRecord.contact.metadata | No | Type: object |
| pendingRecord.contact.metadata.adquisitionChannel | No | Type: string |
| pendingRecord.contact.creditLimit | No | Type: number |
| pendingRecord.soldBy | No | Type: number |
| pendingRecord.type | Yes | Type: enumExample: INVOICE |
| pendingRecord.isSell | Yes | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.date | No | Type: stringExample: |
| pendingRecord.dueDate | No | Type: stringExample: |
| pendingRecord.currency | Yes | Enum-like validator generated by zodFromObj |
| pendingRecord.taxEntityCurrencyRate | No | Type: number |
| pendingRecord.recurrency | No | Type: object |
| pendingRecord.recurrency.isPaused | No | Boolean parser helper from common/utils.zBooleanExample: false |
| pendingRecord.recurrency.isCanceled | No | Boolean parser helper from common/utils.zBooleanExample: false |
| pendingRecord.recurrency.autoChargeEnabled | No | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.recurrency.paymentMethodId | No | Type: string |
| pendingRecord.recurrency.paymentMethodProvider | No | Type: enumExample: stripe |
| pendingRecord.recurrency.date | Yes | Type: arrayExample: |
| pendingRecord.recurrency.date[] | Yes | Type: number |
| pendingRecord.recurrency.date[].month | Yes | Type: number |
| pendingRecord.recurrency.date[].day | Yes | Type: number |
| pendingRecord.recurrency.type | Yes | Type: enumExample: MONTHLY |
| pendingRecord.recurrency.createDaysBefore | No | Type: numberExample: 3 |
| pendingRecord.recurrency.dueAfter | No | Type: number |
| pendingRecord.recurrency.repeatUntil | No | Type: string |
| pendingRecord.recurrency.cancelsAt | No | Type: string |
| pendingRecord.recurrency.pauseAt | No | Type: string |
| pendingRecord.recurrency.continueAfter | No | Type: string |
| pendingRecord.recurrency.inPayrollSince | No | Type: stringExample: |
| pendingRecord.recurrency.pauseOnPastDue | No | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.recurrency.updatePrices | No | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.recurrency.files | No | Type: arrayExample: |
| pendingRecord.recurrency.files[] | Yes | Type: object |
| pendingRecord.recurrency.files[].s3Key | Yes | Type: string |
| pendingRecord.recurrency.files[].fileName | Yes | Type: string |
| pendingRecord.recurrency.automaticallyPaused | No | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.createFirstInvoice | No | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.generateTaxId | No | Type: enumExample: none |
| pendingRecord.taxId | No | Type: stringExample: |
| pendingRecord.taxInvoiceType | No | Type: number |
| pendingRecord.isInstantDelivery | No | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.updatePrices | No | Boolean parser helper from common/utils.zBoolean |
| pendingRecord.elements | No | Type: arrayExample: |
| pendingRecord.elements[] | Yes | Type: unknown |
| pendingRecord.labels | No | Type: arrayExample: |
| pendingRecord.labels[] | Yes | Type: string |
| pendingRecord.clientdata | No | Type: object |
| pendingRecord.metadata | No | Type: unknown |
| pendingRecord.taskId | No | Type: number |
| pendingRecord.payment | No | Type: object |
| pendingRecord.payment.paymentMethod | Yes | Type: enumExample: CASH |
| pendingRecord.payment.accountId | Yes | Type: number |
| pendingRecord.payment.amount | No | Type: number |
| pendingRecord.payment.state | No | Type: enumExample: PENDING |
| pendingRecord.payment.reference | No | Type: string |
| pendingRecord.payment.amountConversion | No | Type: number |
| pendingRecord.payment.receivedFrom | No | Type: number |
| pendingRecord.payment.description | No | Type: string |
| pendingRecord.payment.labels | No | Type: arrayExample: |
| pendingRecord.payment.labels[] | Yes | Type: string |
| pendingRecord.payment.clientdata | No | Type: object |
| pendingRecord.payment.date | No | Type: string |
| pendingRecord.payment.metadata | No | Type: unknown |
| pendingRecord.payment.generateTaxId | No | Type: enumExample: none |
| pendingRecord.credit | No | Type: object |
| pendingRecord.credit.amount | Yes | Type: number |
| pendingRecord.credit.interest | Yes | Type: number |
| pendingRecord.credit.period | Yes | Type: enumExample: DAILY |
| pendingRecord.credit.interestType | No | Type: enumExample: COMPOUND |
| pendingRecord.credit.totalNumberOfPayments | Yes | Type: number |
| pendingRecord.credit.latePaymentFee | No | Type: numberExample: 0 |
| pendingRecord.credit.latePaymentInDays | No | Type: numberExample: 3 |
| pendingRecord.credit.paymentDate | Yes | Type: number |
| pendingRecord.credit.paymentsStartsOn | No | Type: string |
| pendingRecord.credit.pendingRecordId | No | Type: number |
| pendingRecord.credit.accountId | No | Type: number |
| pendingRecord.credit.paymentMethod | No | Type: enumExample: CASH |
| pendingRecord.credit.contact | No | Type: arrayExample: |
| pendingRecord.credit.contact[] | Yes | Type: object |
| pendingRecord.credit.contact[].type | Yes | Type: string |
| pendingRecord.credit.contact[].data | Yes | Type: string |
| pendingRecord.credit.contact[].dataType | No | Type: enumExample: string |
| pendingRecord.redeem | No | Type: object |
| pendingRecord.redeem.returnId | Yes | Type: number |
| pendingRecord.redeem.amount | Yes | Type: number |
| credit | Yes | Type: object |
| credit.amount | Yes | Type: number |
| credit.interest | Yes | Type: number |
| credit.period | Yes | Type: enumExample: DAILY |
| credit.interestType | No | Type: enumExample: COMPOUND |
| credit.totalNumberOfPayments | Yes | Type: number |
| credit.latePaymentFee | No | Type: numberExample: 0 |
| credit.latePaymentInDays | No | Type: numberExample: 3 |
| credit.paymentDate | Yes | Type: number |
| credit.paymentsStartsOn | No | Type: string |
| credit.pendingRecordId | No | Type: number |
| credit.accountId | No | Type: number |
| credit.paymentMethod | No | Type: enumExample: CASH |
| credit.contact | No | Type: arrayExample: |
| credit.contact[] | Yes | Type: object |
| credit.contact[].type | Yes | Type: string |
| credit.contact[].data | Yes | Type: string |
| credit.contact[].dataType | No | Type: enumExample: 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
{}