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