Gestiono
Referencia de APIAccounting / Pending Record

Update Pending Record template

PATCH /v1/record/pending/template • validated by `postPendingRecordTemplate`

← Back to full API reference
PATCH/v1/record/pending/templateAuthentication 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: postPendingRecordTemplate.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • time (required)

    Type: number

  • version (required)

    Type: string

  • invoiceVersion

    Type: string

  • blocks (required)

    Type: array

    Example:

  • blocks[] (required)

    Type: object

  • blocks[].type (required)

    Type: enum

    Example: invoice

  • blocks[].data (required)

    Type: object

  • blocks[].data.shareId (required)

    Type: string

  • blocks[].data.showTaxes

    Boolean parser helper from common/utils.zBoolean

    Example: true

  • blocks[].data.showDescription

    Boolean parser helper from common/utils.zBoolean

  • blocks[].data.showSku

    Boolean parser helper from common/utils.zBoolean

  • blocks[].data.showSignature

    Boolean parser helper from common/utils.zBoolean

  • blocks[].data.extendedClientData

    Boolean parser helper from common/utils.zBoolean

  • blocks[].data.customContent (required)

    Type: object

  • blocks[].data.customContent.top (required)

    Type: string

  • blocks[].data.customContent.middle (required)

    Type: string

  • blocks[].data.customContent.bottom (required)

    Type: string

  • blocks[].data.customContent.organizationName

    Type: string

  • blocks[].data.customContent.chargeTo (required)

    Type: string

  • blocks[].data.customContent.signature

    Type: string

Default payloads

Path params

json
{}

Query

json
{}

Body

json
{
  "time": 1,
  "version": "string",
  "blocks": [
    {
      "type": "invoice",
      "data": {
        "shareId": "string",
        "customContent": {
          "top": "string",
          "middle": "string",
          "bottom": "string",
          "chargeTo": "string"
        }
      }
    }
  ]
}

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

PATCH/v1/record/pending/templateAuthentication required

Group: Accounting / Pending Record

PATCH /v1/record/pending/template • validated by `postPendingRecordTemplate`

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

Body fields

  • timerequired
    Type: number
  • versionrequired
    Type: string
  • invoiceVersion
    Type: string
  • blocksrequired
    Type: array
    Ejemplo:
  • blocks[]required
    Type: object
  • blocks[].typerequired
    Type: enum
    Ejemplo: invoice
  • blocks[].datarequired
    Type: object
  • blocks[].data.shareIdrequired
    Type: string
  • blocks[].data.showTaxes
    Boolean parser helper from common/utils.zBoolean
    Ejemplo: true
  • blocks[].data.showDescription
    Boolean parser helper from common/utils.zBoolean
  • blocks[].data.showSku
    Boolean parser helper from common/utils.zBoolean
  • blocks[].data.showSignature
    Boolean parser helper from common/utils.zBoolean
  • blocks[].data.extendedClientData
    Boolean parser helper from common/utils.zBoolean
  • blocks[].data.customContentrequired
    Type: object
  • blocks[].data.customContent.toprequired
    Type: string
  • blocks[].data.customContent.middlerequired
    Type: string
  • blocks[].data.customContent.bottomrequired
    Type: string
  • blocks[].data.customContent.organizationName
    Type: string
  • blocks[].data.customContent.chargeTorequired
    Type: string
  • blocks[].data.customContent.signature
    Type: string

3. Prepare request payload

4. Server response

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

PATCH /v1/record/pending/unlinkCost

Previous Page

GET /v1/record/pending/:shareId/data

Next Page