.. AUTO-GENERATED FILE. DO NOT EDIT. /accounting-entities-post-one ============================= Summary ------- - **Source repository:** ``jef-systems/jef-accounting-backend`` - **Source SHA:** ``bdf163988317397ace551674e4742588475d154f`` - **Source run id:** ``28366331168`` - **Lambda function:** ``jef-accounting-post-001`` - **HTTP method:** ``POST`` - **API path:** ``/accounting-entities-post-one`` - **Endpoint URL:** ``https://ru8zaxs2qa.execute-api.ap-southeast-1.amazonaws.com/prod/accounting-entities-post-one`` - **Payload mode:** ``json-body`` Description ----------- .. list-table:: :widths: 30 70 * - ``Function`` - jef-accounting-post-001 Logical ID: jef-accounting:jef-accounting-entities:post-one Order Number: 001 * - ``Module`` - jef-accounting * - ``Action`` - post-one * - ``Method`` - POST * - ``Invocation Mode`` - ASYNC * - ``Resource Path`` - /accounting-entities-post-one Endpoint Name: jef-accounting-entities-post-one * - ``Table`` - jef-accounting-entities * - ``Primary Key`` - entity\_id API Gateway Response -------------------- .. list-table:: :widths: 30 70 * - ``status\_code`` - 202 * - ``message`` - Request accepted for asynchronous processing. Payload Example --------------- .. list-table:: :widths: 30 70 * - ``entity\_id`` - 94b0eca2-c08c-4015-8df3-134a5b6f1ec3 * - ``entity\_number`` - value-001 * - ``entity\_name`` - Sample Name * - ``is\_active`` - True * - ``created`` - 2026-06-29T10:42:39Z * - ``updated`` - 2026-06-29T10:42:39Z * - ``children.jef-accounting-external-scanned-documents-raw-ocr-values\[0\].external\_raw\_ocr\_value\_id`` - f647783d-a80c-42a8-bd3f-7614b571a146 * - ``children.jef-accounting-external-scanned-documents-raw-ocr-values\[0\].entity\_id`` - 94b0eca2-c08c-4015-8df3-134a5b6f1ec3 * - ``children.jef-accounting-external-scanned-documents-raw-ocr-values\[0\].raw\_extracted\_ocr\_value`` - value-001 * - ``children.jef-accounting-external-scanned-documents-raw-ocr-values\[0\].created`` - 2026-06-29T10:42:39Z * - ``children.jef-accounting-external-scanned-documents-raw-ocr-values\[0\].updated`` - 2026-06-29T10:42:39Z * - ``children.jef-accounting-internal-scanned-documents-raw-ocr-values\[0\].internal\_raw\_ocr\_value\_id`` - 96957ecf-b670-4f4d-bbd1-f3fa75a05cda * - ``children.jef-accounting-internal-scanned-documents-raw-ocr-values\[0\].entity\_id`` - 94b0eca2-c08c-4015-8df3-134a5b6f1ec3 * - ``children.jef-accounting-internal-scanned-documents-raw-ocr-values\[0\].raw\_extracted\_ocr\_value`` - value-001 * - ``children.jef-accounting-internal-scanned-documents-raw-ocr-values\[0\].created`` - 2026-06-29T10:42:39Z * - ``children.jef-accounting-internal-scanned-documents-raw-ocr-values\[0\].updated`` - 2026-06-29T10:42:39Z Payload Schema -------------- .. code-block:: json { "type": "object", "additionalProperties": "False", "payload_mode": "parent-plus-children-wrapper", "allow_children_wrapper": "True", "children_wrapper_field": "children", "allow_batch": "False", "table": "jef-accounting-entities", "primary_key": "entity_id", "required[0]": "entity_number", "required[1]": "entity_name", "properties.entity_id.field": "entity_id", "properties.entity_id.type": "S", "properties.entity_id.required": "False", "properties.entity_id.source_required": "True", "properties.entity_id.server_generated": "True", "properties.entity_id.autogenerated": "False", "properties.entity_id.frontend_autocomputed": "False", "properties.entity_id.format": "uuidv4", "properties.entity_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "properties.entity_number.field": "entity_number", "properties.entity_number.type": "S", "properties.entity_number.required": "True", "properties.entity_number.source_required": "True", "properties.entity_number.server_generated": "False", "properties.entity_number.autogenerated": "False", "properties.entity_number.frontend_autocomputed": "False", "properties.entity_number.regex": "^[A-Za-z0-9._-]{1,64}$", "properties.entity_name.field": "entity_name", "properties.entity_name.type": "S", "properties.entity_name.required": "True", "properties.entity_name.source_required": "True", "properties.entity_name.server_generated": "False", "properties.entity_name.autogenerated": "False", "properties.entity_name.frontend_autocomputed": "False", "properties.entity_name.regex": "^.{1,200}$", "properties.is_active.field": "is_active", "properties.is_active.type": "BOOL", "properties.is_active.required": "False", "properties.is_active.source_required": "True", "properties.is_active.server_generated": "False", "properties.is_active.autogenerated": "False", "properties.is_active.frontend_autocomputed": "False", "properties.is_active.regex": "^(true|false)$", "properties.created.field": "created", "properties.created.type": "S", "properties.created.required": "False", "properties.created.source_required": "True", "properties.created.server_generated": "True", "properties.created.autogenerated": "False", "properties.created.frontend_autocomputed": "False", "properties.created.format": "iso8601", "properties.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$", "properties.updated.field": "updated", "properties.updated.type": "S", "properties.updated.required": "False", "properties.updated.source_required": "True", "properties.updated.server_generated": "True", "properties.updated.autogenerated": "False", "properties.updated.frontend_autocomputed": "False", "properties.updated.format": "iso8601", "properties.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$", "children[0].parent_table": "jef-accounting-entities", "children[0].child_table": "jef-accounting-external-scanned-documents-raw-ocr-values", "children[0].parent_key": "entity_id", "children[0].child_foreign_key": "entity_id", "children[0].child_index_name": "gsi_1", "children[0].child_index_key": "gsi_1_pk", "children[0].aliases[0]": "jef-accounting-external-scanned-documents-raw-ocr-values", "children[0].aliases[1]": "external-scanned-documents-raw-ocr-values", "children[0].aliases[2]": "accounting-external-scanned-documents-raw-ocr-values", "children[0].aliases[3]": "jef_accounting_external_scanned_documents_raw_ocr_values", "children[0].aliases[4]": "external_scanned_documents_raw_ocr_values", "children[0].aliases[5]": "accounting_external_scanned_documents_raw_ocr_values", "children[0].aliases[6]": "values", "children[1].parent_table": "jef-accounting-entities", "children[1].child_table": "jef-accounting-internal-scanned-documents-raw-ocr-values", "children[1].parent_key": "entity_id", "children[1].child_foreign_key": "entity_id", "children[1].child_index_name": "gsi_1", "children[1].child_index_key": "gsi_1_pk", "children[1].aliases[0]": "jef-accounting-internal-scanned-documents-raw-ocr-values", "children[1].aliases[1]": "internal-scanned-documents-raw-ocr-values", "children[1].aliases[2]": "accounting-internal-scanned-documents-raw-ocr-values", "children[1].aliases[3]": "jef_accounting_internal_scanned_documents_raw_ocr_values", "children[1].aliases[4]": "internal_scanned_documents_raw_ocr_values", "children[1].aliases[5]": "accounting_internal_scanned_documents_raw_ocr_values", "children[1].aliases[6]": "values", "root.type": "object", "root.attributes.entity_id.field": "entity_id", "root.attributes.entity_id.type": "S", "root.attributes.entity_id.required": "False", "root.attributes.entity_id.source_required": "True", "root.attributes.entity_id.server_generated": "True", "root.attributes.entity_id.autogenerated": "False", "root.attributes.entity_id.frontend_autocomputed": "False", "root.attributes.entity_id.format": "uuidv4", "root.attributes.entity_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "root.attributes.entity_number.field": "entity_number", "root.attributes.entity_number.type": "S", "root.attributes.entity_number.required": "True", "root.attributes.entity_number.source_required": "True", "root.attributes.entity_number.server_generated": "False", "root.attributes.entity_number.autogenerated": "False", "root.attributes.entity_number.frontend_autocomputed": "False", "root.attributes.entity_number.regex": "^[A-Za-z0-9._-]{1,64}$", "root.attributes.entity_name.field": "entity_name", "root.attributes.entity_name.type": "S", "root.attributes.entity_name.required": "True", "root.attributes.entity_name.source_required": "True", "root.attributes.entity_name.server_generated": "False", "root.attributes.entity_name.autogenerated": "False", "root.attributes.entity_name.frontend_autocomputed": "False", "root.attributes.entity_name.regex": "^.{1,200}$", "root.attributes.is_active.field": "is_active", "root.attributes.is_active.type": "BOOL", "root.attributes.is_active.required": "False", "root.attributes.is_active.source_required": "True", "root.attributes.is_active.server_generated": "False", "root.attributes.is_active.autogenerated": "False", "root.attributes.is_active.frontend_autocomputed": "False", "root.attributes.is_active.regex": "^(true|false)$", "root.attributes.created.field": "created", "root.attributes.created.type": "S", "root.attributes.created.required": "False", "root.attributes.created.source_required": "True", "root.attributes.created.server_generated": "True", "root.attributes.created.autogenerated": "False", "root.attributes.created.frontend_autocomputed": "False", "root.attributes.created.format": "iso8601", "root.attributes.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$", "root.attributes.updated.field": "updated", "root.attributes.updated.type": "S", "root.attributes.updated.required": "False", "root.attributes.updated.source_required": "True", "root.attributes.updated.server_generated": "True", "root.attributes.updated.autogenerated": "False", "root.attributes.updated.frontend_autocomputed": "False", "root.attributes.updated.format": "iso8601", "root.attributes.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$" } Response Schema --------------- .. code-block:: json { "type": "object", "properties.ok.type": "boolean", "properties.accepted.type": "boolean", "properties.is_committed.type": "boolean", "properties.request_id.type": "string", "properties.message.type": "string", "properties.table.type": "string", "properties.operation.type": "string", "properties.primary_key.type": "string", "properties.primary_key_value.type": "string", "properties.item_write_count.type": "number", "properties.child_write_count.type": "number" } Request Payload --------------- .. code-block:: json { "entity_id": "94b0eca2-c08c-4015-8df3-134a5b6f1ec3", "entity_number": "value-001", "entity_name": "Sample Name", "is_active": "True", "created": "2026-06-29T10:42:39Z", "updated": "2026-06-29T10:42:39Z", "children.jef-accounting-external-scanned-documents-raw-ocr-values[0].external_raw_ocr_value_id": "f647783d-a80c-42a8-bd3f-7614b571a146", "children.jef-accounting-external-scanned-documents-raw-ocr-values[0].entity_id": "94b0eca2-c08c-4015-8df3-134a5b6f1ec3", "children.jef-accounting-external-scanned-documents-raw-ocr-values[0].raw_extracted_ocr_value": "value-001", "children.jef-accounting-external-scanned-documents-raw-ocr-values[0].created": "2026-06-29T10:42:39Z", "children.jef-accounting-external-scanned-documents-raw-ocr-values[0].updated": "2026-06-29T10:42:39Z", "children.jef-accounting-internal-scanned-documents-raw-ocr-values[0].internal_raw_ocr_value_id": "96957ecf-b670-4f4d-bbd1-f3fa75a05cda", "children.jef-accounting-internal-scanned-documents-raw-ocr-values[0].entity_id": "94b0eca2-c08c-4015-8df3-134a5b6f1ec3", "children.jef-accounting-internal-scanned-documents-raw-ocr-values[0].raw_extracted_ocr_value": "value-001", "children.jef-accounting-internal-scanned-documents-raw-ocr-values[0].created": "2026-06-29T10:42:39Z", "children.jef-accounting-internal-scanned-documents-raw-ocr-values[0].updated": "2026-06-29T10:42:39Z" } Response -------- .. code-block:: json { "type": "object", "properties.ok.type": "boolean", "properties.accepted.type": "boolean", "properties.is_committed.type": "boolean", "properties.request_id.type": "string", "properties.message.type": "string", "properties.table.type": "string", "properties.operation.type": "string", "properties.primary_key.type": "string", "properties.primary_key_value.type": "string", "properties.item_write_count.type": "number", "properties.child_write_count.type": "number" } CMD curl -------- .. code-block:: bat curl -X POST "https://ru8zaxs2qa.execute-api.ap-southeast-1.amazonaws.com/prod/accounting-entities-post-one" -H "Content-Type: application/json" --data-raw "{\"entity_id\": \"94b0eca2-c08c-4015-8df3-134a5b6f1ec3\", \"entity_number\": \"value-001\", \"entity_name\": \"Sample Name\", \"is_active\": true, \"created\": \"2026-06-29T10:42:39Z\", \"updated\": \"2026-06-29T10:42:39Z\", \"children\": {\"jef-accounting-external-scanned-documents-raw-ocr-values\": [{\"external_raw_ocr_value_id\": \"f647783d-a80c-42a8-bd3f-7614b571a146\", \"entity_id\": \"94b0eca2-c08c-4015-8df3-134a5b6f1ec3\", \"raw_extracted_ocr_value\": \"value-001\", \"created\": \"2026-06-29T10:42:39Z\", \"updated\": \"2026-06-29T10:42:39Z\"}], \"jef-accounting-internal-scanned-documents-raw-ocr-values\": [{\"internal_raw_ocr_value_id\": \"96957ecf-b670-4f4d-bbd1-f3fa75a05cda\", \"entity_id\": \"94b0eca2-c08c-4015-8df3-134a5b6f1ec3\", \"raw_extracted_ocr_value\": \"value-001\", \"created\": \"2026-06-29T10:42:39Z\", \"updated\": \"2026-06-29T10:42:39Z\"}]}}" PowerShell curl --------------- .. code-block:: powershell curl.exe -X POST "https://ru8zaxs2qa.execute-api.ap-southeast-1.amazonaws.com/prod/accounting-entities-post-one" -H "Content-Type: application/json" --data-raw '{"entity_id": "94b0eca2-c08c-4015-8df3-134a5b6f1ec3", "entity_number": "value-001", "entity_name": "Sample Name", "is_active": true, "created": "2026-06-29T10:42:39Z", "updated": "2026-06-29T10:42:39Z", "children": {"jef-accounting-external-scanned-documents-raw-ocr-values": [{"external_raw_ocr_value_id": "f647783d-a80c-42a8-bd3f-7614b571a146", "entity_id": "94b0eca2-c08c-4015-8df3-134a5b6f1ec3", "raw_extracted_ocr_value": "value-001", "created": "2026-06-29T10:42:39Z", "updated": "2026-06-29T10:42:39Z"}], "jef-accounting-internal-scanned-documents-raw-ocr-values": [{"internal_raw_ocr_value_id": "96957ecf-b670-4f4d-bbd1-f3fa75a05cda", "entity_id": "94b0eca2-c08c-4015-8df3-134a5b6f1ec3", "raw_extracted_ocr_value": "value-001", "created": "2026-06-29T10:42:39Z", "updated": "2026-06-29T10:42:39Z"}]}}'