Welcome to the Topbrands | Acidados API documentation. This API provides a robust and flexible interface for integrating with our platform, allowing you to interact with various resources and services programmatically.
\nWhether you're managing data, automating workflows, or building custom applications, our API is designed to offer comprehensive access to all core functionalities.
\nEach endpoint is crafted to ensure secure, reliable, and efficient communication, making it easier for developers to integrate our features into their projects.
\nPlease refer to the detailed documentation below to get started.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33983030","collectionId":"a42ae878-c6bb-4923-b799-efbef41088a9","publishedId":"2sBXcKCeDG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"F3CC72"},"publishDate":"2026-03-04T23:02:07.000Z"},"item":[{"name":"Products","item":[{"name":"Update Products' Stock Information","id":"9eb49a60-aa91-4b3a-9fed-268cc143be35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Product_Code\": \"\",\n \"Available_Stock\": \"\"\n} ","options":{"raw":{"language":"json"}}},"url":"https://www.zohoapis.eu/crm/v7/functions/endpoint_products_updatestock/actions/execute?auth_type=apikey&zapikey={zapikey}","description":"The request body must include the parameters required to update a product’s stock information in the CRM. These parameters allow the API to identify the product through its product code and the PHC ID associated with the record to be updated.
\nMethod: POST
\nURL:https://www.zohoapis.eu/crm/v7/functions/endpoint_products_updatestock/actions/execute?auth_type=apikey&zapikey={zapikey}
Headers: must provide a private key
\nThis JSON contains the parameters required to update stock information for a product in the CRM.
\nThe endpoint uses the following mandatory fields to identify and update the correct product record:
\nProduct_Code: unique code of the product in the CRM;
\nAvailable_Stock: unique identifier of the product record coming from PHC.
\nBoth fields are required to ensure the API updates the correct product.
\n{\n \"Product_Code\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Available_Stock\": {\n \"type\": \"number\",\n \"mandatory\": true\n },\n}\n\nThe response body is provided in JSON format. Its structure depends on the processing of the data provided in the request body. If the request is successful, the API returns the ID of the property that was created or updated.
\n","urlObject":{"protocol":"https","path":["crm","v7","functions","endpoint_products_updatestock","actions","execute"],"host":["www","zohoapis","eu"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}],"variable":[]}},"response":[{"id":"05b436ce-2f6b-4ac9-a115-5a2827bfd05a","name":"200 OK | Product successfully updated","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Product_Code\": \"Gadget_QA-01\",\n \"Available_Stock\": 13\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_products_updatestock/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_products_updatestock","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:13:36 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"80"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product stock information successfully updated.\",\n \"status\": \"success\"\n}"},{"id":"a82bde73-bc75-4a57-adef-bf4b8eb8ba68","name":"404 Not Found | Product was not found","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Product_Code\": \"23\",\n \"Available_Stock\": 13\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_products_updatestock/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_products_updatestock","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":":status","value":404},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:17:20 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"78"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The given product does not exist in the system.\",\n \"status\": \"error\"\n}"},{"id":"6ee44146-ec73-493a-a030-63ce0cddb7f6","name":"404 Not Found | Missing mandatory fields","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Product_Code\": \"Gadget_QA-01\",\n \"Available_Stock\": 15\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_products_updatestock/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_products_updatestock","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":":status","value":404},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:15:29 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"60"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Mandatory fields are missing.\",\n \"status\": \"error\"\n}"},{"id":"99d57ac3-d05c-4efe-adbe-6e7e3d2539c7","name":"403 Forbidden | Missing credentials","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Product_Code\": \"Gadget_QA-01\",\n \"Available_Stock\": 19\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_products_updatestock/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_products_updatestock","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":[{"key":":status","value":403},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:16:07 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"126"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The provided credentials don't seem to match our records. Please verify your key and try again.\",\n \"status\": \"error\"\n}"}],"_postman_id":"9eb49a60-aa91-4b3a-9fed-268cc143be35"}],"id":"9a3044a5-9fac-411d-bda1-0e811e7a7681","_postman_id":"9a3044a5-9fac-411d-bda1-0e811e7a7681","description":""},{"name":"Sales Order","item":[{"name":"Upsert Sales Order","id":"60feb8eb-ae47-46c8-a939-e7d26f6e49aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Order_Phc_Id\": \"\",\n \"Quote_Crm_Id\": \"\",\n \"Account_Phc_Id\": \"\",\n \"Order_Number\": \"\",\n \"Order_Name\": \"\",\n \"Document_Description\": \"\",\n \"Document_Creation_Date\": \"\",\n \"Due_Date\": \"\",\n \"Currency\": \"\",\n \"Billing_Street\": \"\",\n \"Billing_City\": \"\",\n \"Billing_Country\": \"\",\n \"Billing_State\": \"\",\n \"Billing_Zip_Code\": \"\",\n \"Shipping_Street\": \"\",\n \"Shipping_City\": \"\",\n \"Shipping_Country\": \"\",\n \"Shipping_State\": \"\",\n \"Shipping_Zip_Code\": \"\",\n \"Status\": \"\",\n \"Client_Name\": \"\",\n \"Payment_Conditions\": \"\",\n \"Exchange_Rate\": \"\",\n \"Invoice_Status\": \"\",\n \"Intended_Delivery_Date\": \"\",\n \"Expected_Delivery_Date\": \"\",\n \"Type_Transportation\": \"\",\n \"Expedition_Date\": \"\",\n \"Carrier\": \"\",\n \"Observations\": \"\",\n \"Products\": [\n {\n \"Product_Code\": \"\",\n \"Product_Name\": \"\",\n \"Quantity\": \"\",\n \"Fob_Price\": \"\",\n \"Rec_Pvp_Promo_Price\": \"\",\n \"Rec_Pvp_Price\": \"\",\n \"Unit_Price\": \"\",\n \"Total\": \"\"\n },\n {\n \"Product_Code\": \"\",\n \"Product_Name\": \"\",\n \"Quantity\": \"\",\n \"Fob_Price\": \"\",\n \"Rec_Pvp_Promo_Price\": \"\",\n \"Rec_Pvp_Price\": \"\",\n \"Unit_Price\": \"\",\n \"Total\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","description":"The request body must include the parameters required to create or update a sales order in the CRM. These parameters allow the API to identify the sales order through the PHC order ID and update the corresponding information in the system.
\nMethod: POST
\nURL:https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}
Headers: must provide a private key
\nThis JSON contains the parameters required to create or update a sales order in the CRM.
\nThe endpoint uses the Order_Phc_Id field as the unique identifier of the sales order coming from PHC. If a record with the same PHC ID already exists in CRM, it will be updated. Otherwise, a new record will be created.
\nThe payload must include the sales order information, customer data, billing and shipping details, commercial information, and product lines associated with the order.
\nThe following options are available for this field:
\nStatus: [\"Em Processamento\", \"Enviado\", \"Parcialmente Enviado\", \"Concluído\", \"Cancelado\"] — single select
\nCurrency: [\"EUR\", \"USD\"] — single select
\nPayment_Conditions: [\"Pré-pagamento\", \"15 dias\", \"30 dias\", \"45 dias\", \"60 dias\", \"90 dias\", \"120 dias\"] — single select
\nInvoice_Status: [\"Regularizado\", \"Parcialmente Regularizado\", \"Não Regularizado\"] — single select
\nType_Transportation: [\"Marítimo\", \"Aéreo\", \"Terrestre\", \"Expresso\"] — single select
\nThe Order_Phc_Id field is mandatory to ensure the correct sales order is created or updated. All remaining fields should be sent according to the integration mapping, even when empty, to guarantee consistency between systems.
\nThe values provided must correspond to valid CRM-compatible values. If the unique identifier is missing, the request cannot be processed.
\n{\n \"Order_Phc_Id\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Quote_Crm_Id\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Account_Phc_Id\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Order_Number\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Order_Name\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Document_Description\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Document_Creation_Date\": {\n \"type\": \"string\",\n \"mandatory\": false,\n \"format\": \"yyyy-MM-dd\"\n },\n \"Due_Date\": {\n \"type\": \"string\",\n \"mandatory\": false,\n \"format\": \"yyyy-MM-dd\"\n },\n \"Currency\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Billing_Street\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Billing_City\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Billing_Country\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Billing_State\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Billing_Zip_Code\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Shipping_Street\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Shipping_City\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Shipping_Country\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Shipping_State\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Shipping_Zip_Code\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Status\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Payment_Conditions\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Exchange_Rate\": {\n \"type\": \"number\",\n \"mandatory\": false\n },\n \"Invoice_Status\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Intended_Delivery_Date\": {\n \"type\": \"string\",\n \"mandatory\": false,\n \"format\": \"yyyy-MM-dd\"\n },\n \"Type_Transportation\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Expedition_Date\": {\n \"type\": \"string\",\n \"mandatory\": false,\n \"format\": \"yyyy-MM-dd\"\n },\n \"Carrier\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Observations\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Products\": {\n \"type\": \"array\",\n \"mandatory\": false,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"Product_Code\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Product_Name\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Quantity\": {\n \"type\": \"number\",\n \"mandatory\": true\n },\n \"Fob_Price\": {\n \"type\": \"number\",\n \"mandatory\": false\n },\n \"Rec_Pvp_Promo_Price\": {\n \"type\": \"number\",\n \"mandatory\": false\n },\n \"Rec_Pvp_Price\": {\n \"type\": \"number\",\n \"mandatory\": false\n },\n \"Unit_Price\": {\n \"type\": \"number\",\n \"mandatory\": false\n },\n \"Total\": {\n \"type\": \"number\",\n \"mandatory\": false\n }\n }\n }\n }\n}\n\nThe response body is provided in JSON format. Its structure depends on the processing of the data provided in the request body. If the request is successful, the API returns the ID of the sales order that was created or updated.
\n","urlObject":{"protocol":"https","path":["crm","v7","functions","endpoint_salesorders_upsertrecord","actions","execute"],"host":["www","zohoapis","eu"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}],"variable":[]}},"response":[{"id":"663f7767-7e10-498e-a168-688a95934389","name":"201 Created | Sales order successfully created","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Order_Phc_Id\": \"PHC_SO_000987\",\n \"Quote_Crm_Id\": \"790409000013100001\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Order_Number\": \"ECL-2026-01245\",\n \"Order_Name\": \"Encomenda Cliente - Projeto Alpha\",\n \"Document_Description\": \"Encomenda gerada no PHC para fornecimento de equipamentos\",\n \"Document_Creation_Date\": \"2026-03-15\",\n \"Due_Date\": \"2026-04-15\",\n \"Currency\": \"EUR\",\n \"Billing_Street\": \"Rua das Flores, 120\",\n \"Billing_City\": \"Porto\",\n \"Billing_Country\": \"Portugal\",\n \"Billing_State\": \"Porto\",\n \"Billing_Zip_Code\": \"4050-265\",\n \"Shipping_Street\": \"Zona Industrial de Gaia, Lote 8\",\n \"Shipping_City\": \"Vila Nova de Gaia\",\n \"Shipping_Country\": \"Portugal\",\n \"Shipping_State\": \"Porto\",\n \"Shipping_Zip_Code\": \"4400-123\",\n \"Status\": \"Em Processamento\",\n \"Client_Name\": \"Acidados, Lda.\",\n \"Payment_Conditions\": \"30 dias\",\n \"Exchange_Rate\": 1,\n \"Invoice_Status\": \"Não Faturado\",\n \"Intended_Delivery_Date\": \"2026-03-25\",\n \"Expected_Delivery_Date\": \"2026-03-25\",\n \"Type_Transportation\": \"Transporte Rodoviário\",\n \"Expedition_Date\": \"2026-03-20\",\n \"Carrier\": \"Transportes Silva & Filhos\",\n \"Observations\": \"Entrega faseada conforme disponibilidade de stock.\",\n \"Products\": [\n {\n \"Product_Code\": \"TB009049\",\n \"Product_Name\": \"Compressor Industrial X200\",\n \"Quantity\": 2,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 1500.00,\n \"Total\": 3000.00\n },\n {\n \"Product_Code\": \"TB009028\",\n \"Product_Name\": \"Filtro de Ar Industrial\",\n \"Quantity\": 5,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 120.00,\n \"Total\": 600.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":":status","value":201},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 12:21:34 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"66"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"record_id\": \"790409000014009003\"\n },\n \"message\": \"Sales order successfully created.\",\n \"status\": \"success\"\n}"},{"id":"9c01833b-ed0f-411a-b719-e626538300c2","name":"400 Bad Request | Error while creating the sales order","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Order_Phc_Id\": \"PHC_SO_000987\",\n \"Quote_Crm_Id\": \"790409000013100001\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Order_Number\": \"ECL-2026-01245\",\n \"Order_Name\": \"Encomenda Cliente - Projeto Alpha\",\n \"Document_Description\": \"Encomenda gerada no PHC para fornecimento de equipamentos\",\n \"Document_Creation_Date\": \"2026-03-15\",\n \"Due_Date\": \"2026-04-15\",\n \"Currency\": \"EUR\",\n \"Billing_Street\": \"Rua das Flores, 120\",\n \"Billing_City\": \"Porto\",\n \"Billing_Country\": \"Portugal\",\n \"Billing_State\": \"Porto\",\n \"Billing_Zip_Code\": \"4050-265\",\n \"Shipping_Street\": \"Zona Industrial de Gaia, Lote 8\",\n \"Shipping_City\": \"Vila Nova de Gaia\",\n \"Shipping_Country\": \"Portugal\",\n \"Shipping_State\": \"Porto\",\n \"Shipping_Zip_Code\": \"4400-123\",\n \"Status\": \"Em Processamento\",\n \"Client_Name\": \"Acidados, Lda.\",\n \"Payment_Conditions\": \"30 dias\",\n \"Exchange_Rate\": 1,\n \"Invoice_Status\": \"Não Faturado\",\n \"Intended_Delivery_Date\": \"2026-03-25\",\n \"Expected_Delivery_Date\": \"2026-03-25\",\n \"Type_Transportation\": \"Transporte Rodoviário\",\n \"Expedition_Date\": \"2026-03-20\",\n \"Carrier\": \"Transportes Silva & Filhos\",\n \"Observations\": \"Entrega faseada conforme disponibilidade de stock.\",\n \"Products\": [\n {\n \"Product_Code\": \"TB009049\",\n \"Product_Name\": \"Compressor Industrial X200\",\n \"Quantity\": 2,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 1500.00,\n \"Total\": 3000.00\n },\n {\n \"Product_Code\": \"TB009028\",\n \"Product_Name\": \"Filtro de Ar Industrial\",\n \"Quantity\": 5,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 120.00,\n \"Total\": 600.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":":status","value":400},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 12:16:21 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"77"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error occurred while creating the sales order.\",\n \"status\": \"error\"\n}"},{"id":"b409983d-e64d-4997-935b-ecd42ae64c6d","name":"200 OK | Sales order successfully updated","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Order_Phc_Id\": \"PHC_SO_000987\",\n \"Quote_Crm_Id\": \"790409000013100001\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Order_Number\": \"ECL-2026-01245\",\n \"Order_Name\": \"Encomenda Cliente - Projeto Alpha\",\n \"Document_Description\": \"Encomenda gerada no PHC para fornecimento de equipamentos\",\n \"Document_Creation_Date\": \"2026-03-15\",\n \"Due_Date\": \"2026-04-15\",\n \"Currency\": \"EUR\",\n \"Billing_Street\": \"Rua das Flores, 120\",\n \"Billing_City\": \"Porto\",\n \"Billing_Country\": \"Portugal\",\n \"Billing_State\": \"Porto\",\n \"Billing_Zip_Code\": \"4050-265\",\n \"Shipping_Street\": \"Zona Industrial de Gaia, Lote 8\",\n \"Shipping_City\": \"Vila Nova de Gaia\",\n \"Shipping_Country\": \"Portugal\",\n \"Shipping_State\": \"Porto\",\n \"Shipping_Zip_Code\": \"4400-123\",\n \"Status\": \"Em Processamento\",\n \"Client_Name\": \"Acidados, Lda.\",\n \"Payment_Conditions\": \"30 dias\",\n \"Exchange_Rate\": 1,\n \"Invoice_Status\": \"Não Faturado\",\n \"Intended_Delivery_Date\": \"2026-03-25\",\n \"Expected_Delivery_Date\": \"2026-03-25\",\n \"Type_Transportation\": \"Transporte Rodoviário\",\n \"Expedition_Date\": \"2026-03-20\",\n \"Carrier\": \"Transportes Silva & Filhos\",\n \"Observations\": \"Entrega faseada conforme disponibilidade de stock.\",\n \"Products\": [\n {\n \"Product_Code\": \"TB009049\",\n \"Product_Name\": \"Compressor Industrial X200\",\n \"Quantity\": 2,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 1500.00,\n \"Total\": 3000.00\n },\n {\n \"Product_Code\": \"TB009028\",\n \"Product_Name\": \"Filtro de Ar Industrial\",\n \"Quantity\": 5,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 120.00,\n \"Total\": 600.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 12:29:38 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"66"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"record_id\": \"790409000014009003\"\n },\n \"message\": \"Sales order successfully updated.\",\n \"status\": \"success\"\n}"},{"id":"0fc67038-0baf-49ab-b381-822ffe38166b","name":"400 Bad Request | Error while updating the sales order","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Order_Phc_Id\": \"PHC_SO_000987\",\n \"Quote_Crm_Id\": \"790409000013100001\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Order_Number\": \"ECL-2026-01245\",\n \"Order_Name\": \"Encomenda Cliente - Projeto Alpha\",\n \"Document_Description\": \"Encomenda gerada no PHC para fornecimento de equipamentos\",\n \"Document_Creation_Date\": \"2026-03-15\",\n \"Due_Date\": \"2026-04-15\",\n \"Currency\": \"EUR\",\n \"Billing_Street\": \"Rua das Flores, 120\",\n \"Billing_City\": \"Porto\",\n \"Billing_Country\": \"Portugal\",\n \"Billing_State\": \"Porto\",\n \"Billing_Zip_Code\": \"4050-265\",\n \"Shipping_Street\": \"Zona Industrial de Gaia, Lote 8\",\n \"Shipping_City\": \"Vila Nova de Gaia\",\n \"Shipping_Country\": \"Portugal\",\n \"Shipping_State\": \"Porto\",\n \"Shipping_Zip_Code\": \"4400-123\",\n \"Status\": \"Em Processamento\",\n \"Client_Name\": \"Acidados, Lda.\",\n \"Payment_Conditions\": \"30 dias\",\n \"Exchange_Rate\": 1,\n \"Invoice_Status\": \"Não Faturado\",\n \"Intended_Delivery_Date\": \"2026-03-25\",\n \"Expected_Delivery_Date\": \"2026-03-25\",\n \"Type_Transportation\": \"Transporte Rodoviário\",\n \"Expedition_Date\": \"2026-03-20\",\n \"Carrier\": \"Transportes Silva & Filhos\",\n \"Observations\": \"Entrega faseada conforme disponibilidade de stock.\",\n \"Products\": [\n {\n \"Product_Code\": \"TB009049\",\n \"Product_Name\": \"Compressor Industrial X200\",\n \"Quantity\": 2,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 1500.00,\n \"Total\": 3000.00\n },\n {\n \"Product_Code\": \"TB009028\",\n \"Product_Name\": \"Filtro de Ar Industrial\",\n \"Quantity\": 5,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 120.00,\n \"Total\": 600.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[{"key":":status","value":400},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 12:30:53 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"77"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Error occurred while updating the sales order.\",\n \"status\": \"error\"\n}"},{"id":"a30678b7-5680-4fc4-81f9-c431227d4680","name":"404 Not Found | Missing mandatory fields","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Order_Phc_Id\": \"PHC_SO_000987\",\n \"Quote_Crm_Id\": \"790409000013100001\",\n \"Account_Phc_Id\": \"\",\n \"Order_Number\": \"ECL-2026-01245\",\n \"Order_Name\": \"Encomenda Cliente - Projeto Alpha\",\n \"Document_Description\": \"Encomenda gerada no PHC para fornecimento de equipamentos\",\n \"Document_Creation_Date\": \"2026-03-15\",\n \"Due_Date\": \"2026-04-15\",\n \"Currency\": \"EUR\",\n \"Billing_Street\": \"Rua das Flores, 120\",\n \"Billing_City\": \"Porto\",\n \"Billing_Country\": \"Portugal\",\n \"Billing_State\": \"Porto\",\n \"Billing_Zip_Code\": \"4050-265\",\n \"Shipping_Street\": \"Zona Industrial de Gaia, Lote 8\",\n \"Shipping_City\": \"Vila Nova de Gaia\",\n \"Shipping_Country\": \"Portugal\",\n \"Shipping_State\": \"Porto\",\n \"Shipping_Zip_Code\": \"4400-123\",\n \"Status\": \"Em Processamento\",\n \"Client_Name\": \"Acidados, Lda.\",\n \"Payment_Conditions\": \"30 dias\",\n \"Exchange_Rate\": 1,\n \"Invoice_Status\": \"Não Faturado\",\n \"Intended_Delivery_Date\": \"2026-03-25\",\n \"Expected_Delivery_Date\": \"2026-03-25\",\n \"Type_Transportation\": \"Transporte Rodoviário\",\n \"Expedition_Date\": \"2026-03-20\",\n \"Carrier\": \"Transportes Silva & Filhos\",\n \"Observations\": \"Entrega faseada conforme disponibilidade de stock.\",\n \"Products\": [\n {\n \"Product_Code\": \"TB009049\",\n \"Product_Name\": \"Compressor Industrial X200\",\n \"Quantity\": 2,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 1500.00,\n \"Total\": 3000.00\n },\n {\n \"Product_Code\": \"TB009028\",\n \"Product_Name\": \"Filtro de Ar Industrial\",\n \"Quantity\": 5,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 120.00,\n \"Total\": 600.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":":status","value":404},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 19:36:07 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"60"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Mandatory fields are missing.\",\n \"status\": \"error\"\n}"},{"id":"1da33980-2c68-47b2-b7ba-704c1c860a5c","name":"403 Forbidden | Missing credentials","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Order_Phc_Id\": \"PHC_SO_000987\",\n \"Quote_Crm_Id\": \"790409000013100001\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Order_Number\": \"ECL-2026-01245\",\n \"Order_Name\": \"Encomenda Cliente - Projeto Alpha\",\n \"Document_Description\": \"Encomenda gerada no PHC para fornecimento de equipamentos\",\n \"Document_Creation_Date\": \"2026-03-15\",\n \"Due_Date\": \"2026-04-15\",\n \"Currency\": \"EUR\",\n \"Billing_Street\": \"Rua das Flores, 120\",\n \"Billing_City\": \"Porto\",\n \"Billing_Country\": \"Portugal\",\n \"Billing_State\": \"Porto\",\n \"Billing_Zip_Code\": \"4050-265\",\n \"Shipping_Street\": \"Zona Industrial de Gaia, Lote 8\",\n \"Shipping_City\": \"Vila Nova de Gaia\",\n \"Shipping_Country\": \"Portugal\",\n \"Shipping_State\": \"Porto\",\n \"Shipping_Zip_Code\": \"4400-123\",\n \"Status\": \"Em Processamento\",\n \"Client_Name\": \"Acidados, Lda.\",\n \"Payment_Conditions\": \"30 dias\",\n \"Exchange_Rate\": 1,\n \"Invoice_Status\": \"Não Faturado\",\n \"Intended_Delivery_Date\": \"2026-03-25\",\n \"Expected_Delivery_Date\": \"2026-03-25\",\n \"Type_Transportation\": \"Transporte Rodoviário\",\n \"Expedition_Date\": \"2026-03-20\",\n \"Carrier\": \"Transportes Silva & Filhos\",\n \"Observations\": \"Entrega faseada conforme disponibilidade de stock.\",\n \"Products\": [\n {\n \"Product_Code\": \"TB009049\",\n \"Product_Name\": \"Compressor Industrial X200\",\n \"Quantity\": 2,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 1500.00,\n \"Total\": 3000.00\n },\n {\n \"Product_Code\": \"TB009028\",\n \"Product_Name\": \"Filtro de Ar Industrial\",\n \"Quantity\": 5,\n \"Fob_Price\": 2908,\n \"Rec_Pvp_Promo_Price\": 909,\n \"Rec_Pvp_Price\": 3,\n \"Unit_Price\": 120.00,\n \"Total\": 600.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":[{"key":":status","value":403},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 12:15:14 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"126"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The provided credentials don't seem to match our records. Please verify your key and try again.\",\n \"status\": \"error\"\n}"}],"_postman_id":"60feb8eb-ae47-46c8-a939-e7d26f6e49aa"},{"name":"Update Sales Order Status","id":"d3c89c73-d062-4b09-9208-c3b8fdc1d813","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Crm_Order_Id\": \"\",\n \"Order_Status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_updatestatus/actions/execute?auth_type=apikey&zapikey={zapikey}","description":"The request body must include the parameters required to update a product’s stock information in the CRM. These parameters allow the API to identify the product through its product code and the PHC ID associated with the record to be updated.
\nMethod: POST
\nURL:https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_updatestatus/actions/execute?auth_type=apikey&zapikey={zapikey}
Headers: must provide a private key
\nThis JSON contains the parameters required to update the status of an order in the CRM.
\nThe endpoint requires the Crm_Order_Id to identify the order that needs to be updated and the Order_Status field to define the new state of the order.
\nThe following options are available for this field:
\nBoth fields are mandatory to ensure the correct order is updated with the intended status.
\nThe values provided must correspond to an existing order and a valid status value in the system. If one of these values is missing or invalid, the request cannot be processed.
\n{\n \"Crm_Order_Id\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Order_Status\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n}\n\nThe response body is provided in JSON format. Its structure depends on the processing of the data provided in the request body. If the request is successful, the API returns the ID of the property that was created or updated.
\n","urlObject":{"protocol":"https","path":["crm","v7","functions","endpoint_salesorders_updatestatus","actions","execute"],"host":["www","zohoapis","eu"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}],"variable":[]}},"response":[{"id":"ccb925f0-d7fe-4e12-897b-57cd23e7e3a6","name":"200 OK | Order status successfully updated","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Crm_Order_Id\": \"790409000013476111\",\n \"Order_Status\": \"Concluído\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_updatestatus/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_updatestatus","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:34:44 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"115"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"record_id\": \"790409000013476119\"\n },\n \"message\": \"Sales order status successfully updated.\",\n \"status\": \"success\"\n}"},{"id":"557a7c2e-8c41-4b7f-a536-a12fcd25af9c","name":"400 Bad Request | Unable to update order status","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Crm_Order_Id\": \"790409000013476111\",\n \"Order_Status\": \"Concluído\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_updatestatus/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_updatestatus","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":":status","value":404},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:35:52 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"122"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"record_id\": null\n },\n \"message\": \"Error occurred while updating the sales order status information.\",\n \"status\": \"error\"\n}"},{"id":"3d35e83b-3ab4-43b6-9af3-4257e1d2a102","name":"400 Bad Request | Invalid status","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Crm_Order_Id\": \"790409000013476119\",\n \"Order_Status\": \"Done\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_updatestatus/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_updatestatus","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":":status","value":400},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:36:52 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"82"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid status. Please provide a valid information.\",\n \"status\": \"error\"\n}"},{"id":"33b2c20c-86b1-436a-9f56-e667393ceeb5","name":"404 Not Found | Missing mandatory fields","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Crm_Order_Id\": \"790409000013476119\",\n \"Order_Status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_salesorders_updatestatus/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_salesorders_updatestatus","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":":status","value":404},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 10 Mar 2026 12:34:16 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"60"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Mandatory fields are missing.\",\n \"status\": \"error\"\n}"}],"_postman_id":"d3c89c73-d062-4b09-9208-c3b8fdc1d813"}],"id":"d75cb959-bfe0-4b48-8e4e-c18e5137aeab","_postman_id":"d75cb959-bfe0-4b48-8e4e-c18e5137aeab","description":""},{"name":"Financial Documents","item":[{"name":"Upsert Fiinancial Documents","id":"8b08303a-6820-4f8a-91bc-2a4a67dec093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Financial_Document_Name\": \"\",\n \"Financial_Document_Phc_Id\": \"\",\n \"Internal_Number\": \"\",\n \"Financial_Document_Type\": \"\",\n \"Financial_Document_Status\": \"\",\n \"Account_Phc_Id\": \"\",\n \"Financial_Document_Creation_Date\": \"\",\n \"Financial_Document_Due_Date\": \"\",\n \"Currency\": \"\",\n \"Taxable_Amount\": \"\",\n \"Vat_Total\": \"\",\n \"Total\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","urlObject":{"protocol":"https","path":["crm","v7","functions","endpoint_financialdocuments_upsertrecord","actions","execute"],"host":["www","zohoapis","eu"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}],"variable":[]}},"response":[{"id":"be6f7e8a-3a71-4e6f-89bb-172ff1141f41","name":"200 OK | Financial document successfully updated","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Financial_Document_Name\": \"Invoice FT 2024/0158\",\n \"Financial_Document_Phc_Id\": \"PHC-FT-2024-0158\",\n \"Internal_Number\": 1,\n \"Financial_Document_Type\": \"Fatura\",\n \"Financial_Document_Status\": \"Regularizado\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Financial_Document_Creation_Date\": \"2024-11-15\",\n \"Financial_Document_Due_Date\": \"2024-12-15\",\n \"Currency\": \"EUR\",\n \"Taxable_Amount\": 1000.00,\n \"Vat_Total\": 230.00,\n \"Total\": 1230.00\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_financialdocuments_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"server","value":"ZGS"},{"key":"date","value":"Mon, 16 Mar 2026 10:39:11 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"73"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Financial document successfully updated.\",\n \"status\": \"success\"\n}"},{"id":"42630632-a6e8-4ad6-84b6-c9a0e4f089df","name":"201 Created | Financial document successfully created","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Financial_Document_Name\": \"Invoice FT 2024/0158\",\n \"Financial_Document_Phc_Id\": \"PHC-FT-2024-0158\",\n \"Internal_Number\": 1,\n \"Financial_Document_Type\": \"Fatura\",\n \"Financial_Document_Status\": \"Regularizado\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Financial_Document_Creation_Date\": \"2024-11-15\",\n \"Financial_Document_Due_Date\": \"2024-12-15\",\n \"Currency\": \"EUR\",\n \"Taxable_Amount\": 1000.00,\n \"Vat_Total\": 230.00,\n \"Total\": 1230.00\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_financialdocuments_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":":status","value":201},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 08:43:03 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"73"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Financial document successfully created.\",\n \"status\": \"success\"\n}"},{"id":"cbe71878-583f-4b03-b7a8-16a26aca462f","name":"400 Bad Request | Invalid document type","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Financial_Document_Name\": \"Invoice FT 2024/0158\",\n \"Financial_Document_Phc_Id\": \"PHC-FT-2024-0158\",\n \"Internal_Number\": 1,\n \"Financial_Document_Type\": \"Faturas\",\n \"Financial_Document_Status\": \"Regularizado\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Financial_Document_Creation_Date\": \"2024-11-15\",\n \"Financial_Document_Due_Date\": \"2024-12-15\",\n \"Currency\": \"EUR\",\n \"Taxable_Amount\": 1000.00,\n \"Vat_Total\": 230.00,\n \"Total\": 1230.00\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_financialdocuments_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":":status","value":400},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 09:44:31 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"89"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid document type. Please provide a valid information.\",\n \"status\": \"error\"\n}"},{"id":"1f5fb967-1699-4f75-82d0-4b79da37771c","name":"400 Bad Request | Invalid document status","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Financial_Document_Name\": \"Invoice FT 2024/0158\",\n \"Financial_Document_Phc_Id\": \"PHC-FT-2024-0158\",\n \"Internal_Number\": 1,\n \"Financial_Document_Type\": \"Fatura\",\n \"Financial_Document_Status\": \" N Regularizado\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Financial_Document_Creation_Date\": \"2024-11-15\",\n \"Financial_Document_Due_Date\": \"2024-12-15\",\n \"Currency\": \"EUR\",\n \"Taxable_Amount\": 1000.00,\n \"Vat_Total\": 230.00,\n \"Total\": 1230.00\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_financialdocuments_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":":status","value":400},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 09:45:05 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"82"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid document status. Please provide a valid information.\",\n \"status\": \"error\"\n}"},{"id":"7b7faec4-22ad-496f-a0f8-09e281ece3de","name":"404 Not Found | Missing mandatory fields","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Financial_Document_Name\": \"Invoice FT 2024/0158\",\n \"Financial_Document_Phc_Id\": \"\",\n \"Internal_Number\": 1,\n \"Financial_Document_Type\": \"Fatura\",\n \"Financial_Document_Status\": \"Regularizado\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Financial_Document_Creation_Date\": \"2024-11-15\",\n \"Financial_Document_Due_Date\": \"2024-12-15\",\n \"Currency\": \"EUR\",\n \"Taxable_Amount\": 1000.00,\n \"Vat_Total\": 230.00,\n \"Total\": 1230.00\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_financialdocuments_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":":status","value":404},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 08:47:32 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"60"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Mandatory fields are missing.\",\n \"status\": \"error\"\n}"},{"id":"5c89a067-b67e-45fb-a100-c908fb1a2b4e","name":"403 Forbidden | Missing credentials","originalRequest":{"method":"POST","header":[{"key":"private-key","value":"{private-key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Financial_Document_Name\": \"Invoice FT 2024/0158\",\n \"Financial_Document_Phc_Id\": \"\",\n \"Internal_Number\": 1,\n \"Financial_Document_Type\": \"Fatura\",\n \"Financial_Document_Status\": \"Regularizado\",\n \"Account_Phc_Id\": \"TESTELOBA1\",\n \"Financial_Document_Creation_Date\": \"2024-11-15\",\n \"Financial_Document_Due_Date\": \"2024-12-15\",\n \"Currency\": \"EUR\",\n \"Taxable_Amount\": 1000.00,\n \"Vat_Total\": 230.00,\n \"Total\": 1230.00\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey={zapikey}","protocol":"https","host":["www","zohoapis","eu"],"path":["crm","v7","functions","endpoint_financialdocuments_upsertrecord","actions","execute"],"query":[{"key":"auth_type","value":"apikey"},{"key":"zapikey","value":"{zapikey}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":":status","value":404},{"key":"server","value":"ZGS"},{"key":"date","value":"Tue, 17 Mar 2026 08:47:32 GMT"},{"key":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"60"},{"key":"content-disposition","value":"attachment; filename=response.json"},{"key":"strict-transport-security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Mandatory fields are missing.\",\n \"status\": \"error\"\n}"}],"_postman_id":"8b08303a-6820-4f8a-91bc-2a4a67dec093"}],"id":"2f950f54-4ba0-45a4-abc2-a8091ef7a025","description":"The request body must include the parameters required to update a product’s stock information in the CRM. These parameters allow the API to identify the product through its product code and the PHC ID associated with the record to be updated.
\nMethod: POST
\nURL:https://www.zohoapis.eu/crm/v7/functions/endpoint_financialdocuments_upsertrecord/actions/execute?auth_type=apikey&zapikey=zapikey}
Headers: must provide a private key
\nThis JSON contains the parameters required to create or update a financial document in the CRM.
\nThe endpoint requires the Financial_Document_Phc_Id to identify the financial document that needs to be created or updated. The Account_Phc_Id and Order_Phc_Id fields define the account and the sales order associated to each financial document.
\nThe following options are available for this field:
\nFinancial_Document_Type: [\"Fatura\",\" Fatura Recibo Worten\",\"NC Recibo Worten\",\"Nota de Crédito\",\"V/Nota de Deb. FL\",\"V/NC FL\", \"V/NCC FL\", \"V/Nota Deb. Custo FL\"] — single select
\nFinancial_Document_Status: [\"Regularizado\", \"Parcialmente Regularizado\", \"Não Regularizado\"] — single select
\nCurrency: [\"EUR\", \"USD\"] — single select
\nBoth fields are mandatory to ensure the correct financial document is created or updated with the intended status.
\nThe values provided must correspond to a valid financial document identifier and a valid status value configured in the system. If one of these values is missing or invalid, the request cannot be processed.
\n{\n \"Financial_Document_Name\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Financial_Document_Phc_Id\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Internal_Number\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Financial_Document_Type\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Financial_Document_Status\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Account_Phc_Id\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Order_Phc_Id\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Financial_Document_Creation_Date\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Financial_Document_Due_Date\": {\n \"type\": \"string\",\n \"mandatory\": true\n },\n \"Currency\": {\n \"type\": \"string\",\n \"mandatory\": false\n },\n \"Taxable_Amount\": {\n \"type\": \"currency\",\n \"mandatory\": true\n },\n \"Vat_Total\": {\n \"type\": \"currency\",\n \"mandatory\": true\n },\n \"Total\": {\n \"type\": \"currency\",\n \"mandatory\": true\n }\n}\n\nThe response body is provided in JSON format. Its structure depends on the processing of the data provided in the request body. If the request is successful, the API returns the ID of the property that was created or updated.
\n","_postman_id":"2f950f54-4ba0-45a4-abc2-a8091ef7a025"}]}