### SS07. Get Contractors Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Retrieves a list of contractors from SaldeoSMART. ```APIDOC ## GET /api/contractors ### Description Retrieves a list of contractors from the SaldeoSMART system. Supports filtering. ### Method GET ### Endpoint /api/contractors ### Parameters #### Query Parameters - **company_id** (string) - Optional - Filter contractors by company ID. - **search** (string) - Optional - Search term for contractor names or NIP. ### Response #### Success Response (200) - **contractors** (array) - A list of contractor objects. - **contractor_id** (string) - The unique identifier of the contractor. - **name** (string) - The name of the contractor. - **nip** (string) - The NIP of the contractor. #### Response Example ```json { "contractors": [ { "contractor_id": "cont_123", "name": "Supplier Inc.", "nip": "98-76-54-32" } ] } ``` ``` -------------------------------- ### SS08. Get Recognized Documents List Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Retrieves a list of documents that have been recognized by SaldeoSMART. ```APIDOC ## GET /api/documents?status=recognized ### Description Retrieves a list of documents that have been successfully recognized by SaldeoSMART. ### Method GET ### Endpoint /api/documents ### Parameters #### Query Parameters - **status** (string) - Required - Filter by 'recognized' status. - **company_id** (string) - Optional - Filter by company ID. ### Response #### Success Response (200) - **documents** (array) - A list of recognized document objects. - **document_id** (string) - The unique identifier of the document. - **name** (string) - The name of the document. - **recognition_data** (object) - Data extracted during recognition. #### Response Example ```json { "documents": [ { "document_id": "doc_klmno", "name": "Receipt_2023.pdf", "recognition_data": { "total_amount": 150.75, "date": "2023-10-26" } } ] } ``` ``` -------------------------------- ### SS04. Get Companies Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Retrieves information about companies registered in SaldeoSMART. ```APIDOC ## GET /api/companies/{id} ### Description Retrieves detailed information about a specific company in SaldeoSMART. ### Method GET ### Endpoint /api/companies/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the company to retrieve. ### Response #### Success Response (200) - **company_details** (object) - Details of the company. - **name** (string) - The name of the company. - **address** (string) - The address of the company. - **created_at** (string) - Timestamp of when the company was created. #### Response Example ```json { "company_details": { "name": "Example Company", "address": "123 Main St", "created_at": "2023-10-27T10:00:00Z" } } ``` ``` -------------------------------- ### SS01. Add Company to Saldeo Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Adds a company to the SaldeoSMART system. This operation is crucial for initial setup and integration. ```APIDOC ## POST /api/companies ### Description Adds a new company to the SaldeoSMART system. ### Method POST ### Endpoint /api/companies ### Parameters #### Request Body - **company_data** (object) - Required - Data for the company to be added. - **name** (string) - Required - The name of the company. - **address** (string) - Optional - The address of the company. ### Request Example ```json { "company_data": { "name": "Example Company", "address": "123 Main St" } } ``` ### Response #### Success Response (200) - **company_id** (string) - The unique identifier for the newly added company. #### Response Example ```json { "company_id": "comp_12345" } ``` ``` -------------------------------- ### SS19. Get Bank Statement List Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Retrieves a list of bank statements available in SaldeoSMART. ```APIDOC ## GET /api/bank_statements ### Description Retrieves a list of bank statements from SaldeoSMART. ### Method GET ### Endpoint /api/bank_statements ### Parameters #### Query Parameters - **company_id** (string) - Optional - Filter by company ID. - **date_from** (string) - Optional - Filter by statement date (YYYY-MM-DD). - **date_to** (string) - Optional - Filter by statement date (YYYY-MM-DD). ### Response #### Success Response (200) - **bank_statements** (array) - A list of bank statement objects. - **statement_id** (string) - The unique identifier of the bank statement. - **account_number** (string) - The bank account number. - **statement_date** (string) - The date of the statement. #### Response Example ```json { "bank_statements": [ { "statement_id": "bs_111", "account_number": "1234567890", "statement_date": "2023-10-26" } ] } ``` ``` -------------------------------- ### SS15. Link Companies in Saldeo with FK - Set COMPANY_PROGRAM_ID Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Establishes a link between Saldeo companies and external accounting programs by setting the COMPANY_PROGRAM_ID. ```APIDOC ## PUT /api/companies/{id}/link ### Description Links a company in SaldeoSMART with an external accounting program by setting the COMPANY_PROGRAM_ID. ### Method PUT ### Endpoint /api/companies/{id}/link ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the SaldeoSMART company. #### Request Body - **link_data** (object) - Required - Data for linking the company. - **program_id** (string) - Required - The identifier from the external accounting program (FK). ### Request Example ```json { "link_data": { "program_id": "FK_Company_XYZ" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the company has been linked. #### Response Example ```json { "message": "Company linked successfully with accounting program." } ``` ``` -------------------------------- ### SS24. Import Documents Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Imports documents into SaldeoSMART. This is a general import function. ```APIDOC ## POST /api/documents/import ### Description Imports one or more documents into the ``` -------------------------------- ### SS03. List Documents Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Retrieves a list of documents from SaldeoSMART. Supports filtering and pagination. ```APIDOC ## GET /api/documents ### Description Retrieves a list of documents from the SaldeoSMART system. Supports filtering by company and status. ### Method GET ### Endpoint /api/documents ### Parameters #### Query Parameters - **company_id** (string) - Optional - Filter documents by company ID. - **status** (string) - Optional - Filter documents by status (e.g., 'processed', 'pending'). - **page** (integer) - Optional - Page number for pagination. - **limit** (integer) - Optional - Number of items per page. ### Response #### Success Response (200) - **documents** (array) - A list of document objects. - **document_id** (string) - The unique identifier of the document. - **name** (string) - The name of the document. - **status** (string) - The current status of the document. #### Response Example ```json { "documents": [ { "document_id": "doc_abcde", "name": "Invoice_001.pdf", "status": "processed" } ] } ``` ``` -------------------------------- ### SS05. Add Document Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Adds a new document to SaldeoSMART. This endpoint is used for uploading new files. ```APIDOC ## POST /api/documents ### Description Adds a new document to the SaldeoSMART system. This typically involves uploading a file. ### Method POST ### Endpoint /api/documents ### Parameters #### Request Body - **document_file** (file) - Required - The document file to upload. - **company_id** (string) - Required - The ID of the company this document belongs to. - **metadata** (object) - Optional - Additional metadata for the document. ### Request Example (Multipart form data would be used for file upload) ### Response #### Success Response (200) - **document_id** (string) - The unique identifier for the newly added document. - **status** (string) - The initial status of the document (e.g., 'uploaded'). #### Response Example ```json { "document_id": "doc_fghij", "status": "uploaded" } ``` ``` -------------------------------- ### SS06. Recognize Documents Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Initiates document recognition processing within SaldeoSMART. Used after documents have been uploaded. ```APIDOC ## POST /api/documents/{id}/recognize ### Description Initiates the document recognition process for a specific document. ### Method POST ### Endpoint /api/documents/{id}/recognize ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the document to recognize. ### Response #### Success Response (200) - **message** (string) - Confirmation message that recognition has started. #### Response Example ```json { "message": "Document recognition initiated." } ``` ``` -------------------------------- ### SS14. Update Economic Event Descriptions (v1.61.0) Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Updates descriptions for economic events, with a specific version mentioned. ```APIDOC ## PUT /api/economic_events/descriptions ### Description Updates the descriptions for economic events. This version is specific to v1.61.0. ### Method PUT ### Endpoint /api/economic_events/descriptions ### Parameters #### Request Body - **event_updates** (array) - Required - A list of economic event updates. - **event_id** (string) - Required - The ID of the economic event. - **new_description** (string) - Required - The updated description. ### Request Example ```json { "event_updates": [ { "event_id": "ee_001", "new_description": "Updated description for event 001." } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the updates were applied. #### Response Example ```json { "message": "Economic event descriptions updated successfully." } ``` ``` -------------------------------- ### SS18. Search Document by Policy and Parameters Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Searches for documents using specific policies and parameters provided in an XML format. ```APIDOC ## POST /api/documents/search ### Description Searches for documents based on a provided policy and parameters within an XML structure. ### Method POST ### Endpoint /api/documents/search ### Parameters #### Request Body - **search_query** (string) - Required - An XML string containing the search policy and parameters. ### Request Example ```xml invoice_date 2023-01-01 2023-12-31 ``` ### Response #### Success Response (200) - **matching_documents** (array) - A list of document IDs that match the search criteria. - **document_id** (string) - The unique identifier of a matching document. #### Response Example ```json { "matching_documents": [ "doc_uvwxy", "doc_zabcd" ] } ``` ``` -------------------------------- ### SS20. Set Dimensions on Document Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Assigns specific dimensions to a document within SaldeoSMART. ```APIDOC ## POST /api/documents/{id}/dimensions ### Description Assigns or updates dimensions for a specific document in SaldeoSMART. ### Method POST ### Endpoint /api/documents/{id}/dimensions ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the document. #### Request Body - **dimensions** (object) - Required - Key-value pairs representing the dimensions to set. ### Request Example ```json { "dimensions": { "project_code": "PROJ789", "cost_center": "CC101" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating dimensions were set. #### Response Example ```json { "message": "Dimensions set successfully for the document." } ``` ``` -------------------------------- ### SS22. List Document IDs Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Retrieves a list of all document identifiers within SaldeoSMART. ```APIDOC ## GET /api/documents/ids ### Description Retrieves a list of all unique document identifiers available in SaldeoSMART. ### Method GET ### Endpoint /api/documents/ids ### Parameters (No specific parameters required for a basic list, but filters like company_id might be applicable.) ### Response #### Success Response (200) - **document_ids** (array) - An array of strings, where each string is a document ID. #### Response Example ```json { "document_ids": [ "doc_123", "doc_456", "doc_789" ] } ``` ``` -------------------------------- ### SS10. Update Registry Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Updates registry information within SaldeoSMART. ```APIDOC ## PUT /api/registries/{id} ### Description Updates an existing registry in SaldeoSMART. ### Method PUT ### Endpoint /api/registries/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the registry to update. #### Request Body - **registry_data** (object) - Required - The updated data for the registry. - **name** (string) - Optional - The new name for the registry. - **value** (string) - Optional - The updated value for the registry. ### Request Example ```json { "registry_data": { "value": "New Registry Value" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the registry was updated. #### Response Example ```json { "message": "Registry updated successfully." } ``` ``` -------------------------------- ### SS02. Update Contractor Database Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Updates the contractor database within SaldeoSMART. Allows for synchronization of contractor information. ```APIDOC ## PUT /api/contractors/{id} ### Description Updates an existing contractor in the SaldeoSMART system. ### Method PUT ### Endpoint /api/contractors/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the contractor to update. #### Request Body - **contractor_data** (object) - Required - The updated data for the contractor. - **name** (string) - Optional - The updated name of the contractor. - **nip** (string) - Optional - The updated NIP (tax identification number). ### Request Example ```json { "contractor_data": { "name": "Updated Contractor Name", "nip": "123-456-78-90" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the contractor was updated. #### Response Example ```json { "message": "Contractor updated successfully." } ``` ``` -------------------------------- ### SS21. Update Item List Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Updates the list of items or products available in SaldeoSMART. ```APIDOC ## PUT /api/items ### Description Updates the list of items (products) in SaldeoSMART. This can involve adding, modifying, or deleting items. ### Method PUT ### Endpoint /api/items ### Parameters #### Request Body - **item_updates** (array) - Required - A list of item updates. - **item_id** (string) - Optional - The ID of the item to update (if modifying or deleting). - **name** (string) - Required - The name of the item. - **price** (number) - Optional - The price of the item. - **action** (string) - Required - The action to perform ('add', 'update', 'delete'). ### Request Example ```json { "item_updates": [ { "item_id": "item_abc", "action": "update", "price": 19.99 }, { "name": "New Gadget", "price": 99.00, "action": "add" } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the item list update process. #### Response Example ```json { "message": "Item list update process completed." } ``` ``` -------------------------------- ### SS16. Delete Documents (v1.70.1) Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Deletes documents from SaldeoSMART. This endpoint is versioned (1.70.1). ```APIDOC ## DELETE /api/documents/{id} ### Description Deletes a specific document from SaldeoSMART. This operation is versioned (v1.70.1). ### Method DELETE ### Endpoint /api/documents/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the document to delete. ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the document was deleted. #### Response Example ```json { "message": "Document deleted successfully." } ``` ``` -------------------------------- ### SS12. Set Dimensions Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Sets or updates dimensions for a company or document in SaldeoSMART. ```APIDOC ## POST /api/dimensions ### Description Sets or updates dimensions for a company or document in SaldeoSMART. ### Method POST ### Endpoint /api/dimensions ### Parameters #### Request Body - **dimension_data** (object) - Required - Data for setting dimensions. - **entity_id** (string) - Required - The ID of the entity (company or document) to which dimensions apply. - **entity_type** (string) - Required - The type of entity ('company' or 'document'). - **dimensions** (object) - Required - Key-value pairs representing dimensions. ### Request Example ```json { "dimension_data": { "entity_id": "comp_12345", "entity_type": "company", "dimensions": { "department": "Sales", "region": "North" } } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating dimensions were set. #### Response Example ```json { "message": "Dimensions set successfully." } ``` ``` -------------------------------- ### SS11. Update Payment Method Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Updates payment method details in SaldeoSMART. ```APIDOC ## PUT /api/payment_methods/{id} ### Description Updates an existing payment method in SaldeoSMART. ### Method PUT ### Endpoint /api/payment_methods/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the payment method to update. #### Request Body - **payment_method_data** (object) - Required - The updated data for the payment method. - **name** (string) - Optional - The new name for the payment method. - **type** (string) - Optional - The updated type of payment method. ### Request Example ```json { "payment_method_data": { "name": "Updated Payment Method Name" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the payment method was updated. #### Response Example ```json { "message": "Payment method updated successfully." } ``` ``` -------------------------------- ### SS17. Edit Document Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Edits the details or content of an existing document in SaldeoSMART. ```APIDOC ## PUT /api/documents/{id} ### Description Edits an existing document in SaldeoSMART. This can include updating metadata or content. ### Method PUT ### Endpoint /api/documents/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the document to edit. #### Request Body - **document_update** (object) - Required - The updated data for the document. - **field_to_update** (string) - Required - The name of the field to update. - **new_value** (any) - Required - The new value for the field. ### Request Example ```json { "document_update": { "field_to_update": "description", "new_value": "Updated description for the invoice." } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the document was updated. #### Response Example ```json { "message": "Document updated successfully." } ``` ``` -------------------------------- ### SS23. List Documents by Document IDs Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Retrieves document details for a given list of document identifiers. ```APIDOC ## POST /api/documents/list_by_ids ### Description Retrieves detailed information for a specific list of documents using their identifiers. ### Method POST ### Endpoint /api/documents/list_by_ids ### Parameters #### Request Body - **document_ids** (array) - Required - An array of document IDs for which to retrieve details. ### Request Example ```json { "document_ids": [ "doc_123", "doc_456" ] } ``` ### Response #### Success Response (200) - **documents** (array) - A list of document objects corresponding to the provided IDs. - **document_id** (string) - The unique identifier of the document. - **name** (string) - The name of the document. - **status** (string) - The status of the document. #### Response Example ```json { "documents": [ { "document_id": "doc_123", "name": "Invoice_Jan.pdf", "status": "processed" }, { "document_id": "doc_456", "name": "Receipt_Feb.pdf", "status": "pending" } ] } ``` ``` -------------------------------- ### SS09. Update Category Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Updates the category associated with a document or item in SaldeoSMART. ```APIDOC ## PUT /api/categories/{id} ### Description Updates an existing category in SaldeoSMART. ### Method PUT ### Endpoint /api/categories/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the category to update. #### Request Body - **category_data** (object) - Required - The updated data for the category. - **name** (string) - Optional - The new name for the category. - **description** (string) - Optional - An updated description for the category. ### Request Example ```json { "category_data": { "name": "Updated Category Name" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the category was updated. #### Response Example ```json { "message": "Category updated successfully." } ``` ``` -------------------------------- ### SS13. Cyclic Transfer of Accounting Program Number Source: https://docs.google.com/document/d/1xdC4-PylLht9UodcBFmtD4vOONAWqTiEk9nq98ZQxvU/edit/index_tab=t.0 Cyclically transfers numbers from the accounting program. This is a background or scheduled operation. ```APIDOC ## POST /api/accounting/transfer_numbers ### Description Initiates a cyclic transfer of numbers from the accounting program to SaldeoSMART. This is typically a scheduled or background job. ### Method POST ### Endpoint /api/accounting/transfer_numbers ### Parameters (This endpoint might not require direct parameters if it's a scheduled task, or it might accept a specific trigger key.) ### Response #### Success Response (200) - **message** (string) - Confirmation message that the transfer process has been initiated or completed. #### Response Example ```json { "message": "Accounting number transfer process initiated." } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.