Using the Good Sign REST API, you can build and integrate with your Good Sign SaaS tenant programmatically, via HTTPS. The API gives you simple access to the functionality on Good Sign. You can use this access to create your own custom applications or to script interactions with your Good Sign.
\nFor information on prerequisites and how to use the Good Sign REST API, please refer to the Good Sign REST API documentation here. To obtain credentials to API contact Good Sign support.
\nGood Sign API supports two authentication modes. Basic Auth with a session token is the default. JWT Bearer is an opt-in alternative configured per environment.
\n/gsapi/welcome with a Basic Auth header (username and password, base64-encoded):Authorization: Basic base64(username:password)\n\nThe response includes a VompApiToken header. Copy this value.
Add the token to all subsequent GSAPI requests:
\nVompApiToken: <token>\n\nIf the environment is configured for JWT authentication (Jwt:Enabled: true):
Obtain a JWT from your identity provider (e.g. Keycloak, Auth0).
\nSend it as a Bearer token on each request:
\nAuthorization: Bearer <jwt>\n\nIf the environment also has GenerateApiToken enabled, the API returns a VompApiToken in the response header alongside JWT authentication. Both approaches are then valid for subsequent calls: use the VompApiToken header as with Basic Auth, or continue sending Authorization: Bearer on each request. The choice is typically made when JWT/OAuth2 is configured for the environment.
Some environments disable Basic Auth entirely with DisableBasicAuthentication: true. In those environments, JWT Bearer is the only valid authentication method.
JWT best practices: Keep token lifetime short (minutes to one hour maximum). Leave issuer, audience, and lifetime validation enabled on the server side.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Prerequisites","slug":"prerequisites"},{"content":"Authentication","slug":"authentication"}],"owner":"10076250","collectionId":"6bf8b169-cfed-4ddb-82cb-4d1d268f6fc4","publishedId":"TVKJxum6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-29T08:04:04.000Z"},"item":[{"name":"Welcome","item":[{"name":"Welcome","id":"e0e8e38c-27a3-43d2-9deb-158339954053","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.goodsign.cloud/api/interface/gsapi/welcome","description":"Returns a welcome message and a VompApiToken in the response header. Use this token for subsequent GSAPI requests that require token-based authentication. This endpoint is useful for testing API connectivity and validating credentials.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Lists organizations based on filters. Without parameters a full list or organizations is returned filtered only by user rights.
\nYou can include zero, one or multiple parameters to limit your search. Multiple parameters are used with AND condition.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Filter by the organizations parent - returns only direct child organizations
\n","type":"text/plain"},"key":"parent_org_id","value":"0"},{"description":{"content":"Filter by org_id - returns given organization only
\n","type":"text/plain"},"key":"org_id","value":"1203"},{"disabled":true,"description":{"content":"Filter by business id exact match
\n","type":"text/plain"},"key":"business_id","value":"Filter by name use % for wildcars
\n","type":"text/plain"},"key":"company_name","value":"<%string%>"},{"disabled":true,"description":{"content":"Filter by external_customer_id exact match
\n","type":"text/plain"},"key":"external_customer_id","value":"Filter by external_customer_id2 exact match
\n","type":"text/plain"},"key":"external_customer_id2","value":"With inherit=1, includes grand-children under parent_org_id. With inherit=0 (default), returns only direct children.
\n","type":"text/plain"},"key":"inherit","value":"1"}],"variable":[]}},"response":[{"id":"47fbcfa1-5e10-4dc8-8016-073f30b56045","name":"List Organizations","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.goodsign.cloud/api/interface/gsapi/organizations/list?org_id=1202","protocol":"https","host":["api","goodsign","cloud"],"path":["api","interface","gsapi","organizations","list"],"query":[{"key":"parent_org_id","value":"0","description":"Filter by the organizations parent - returns only direct child organizations","disabled":true},{"key":"org_id","value":"1202","description":"Filter by org_id - returns given organization only"},{"key":"business_id","value":"Show detailed information on a given org_id filtered by query parameters. Without any parameters returns all organizations filtered by user rights only. Filter parameters are used with AND condition.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"GS Organization ID
\n","type":"text/plain"},"key":"org_id","value":"1202"},{"disabled":true,"description":{"content":"Excternal customer id
\n","type":"text/plain"},"key":"external_customer_id","value":""},{"disabled":true,"description":{"content":"External customer id2
\n","type":"text/plain"},"key":"External_customer_id2","value":""},{"key":"company_name","value":null}],"variable":[]}},"response":[{"id":"3fbec45e-1cde-46f1-8f60-7d65f9f9e89c","name":"Get Organization","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.goodsign.cloud/api/interface/gsapi/organization/actions?org_id=1202","protocol":"https","host":["api","goodsign","cloud"],"path":["api","interface","gsapi","organization","actions"],"query":[{"key":"org_id","value":"1202","description":"GS Organization ID"},{"key":"parent_org_id","value":null,"description":"Parent organization id, returns all direct child organizations","type":"text","disabled":true},{"key":"external_customer_id","value":null,"description":"Excternal customer id","type":"text","disabled":true},{"key":"External_customer_id2","value":null,"description":"External customer id2","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"VompApiToken","value":"MjUzODZiZTktZjAwMC00YTc5LWE2OWQtZDRmNTk4NWZjZTYz"},{"key":"X-XSS-Protection","value":"0; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Date","value":"Wed, 02 Nov 2022 21:49:16 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"org_id\": 1202,\n \"company_name\": \"ApiDemoCloud\",\n \"parent_org_id\": 0,\n \"sc_site_code\": null,\n \"addr_street1\": null,\n \"addr_street2\": null,\n \"addr_zipcode\": null,\n \"addr_city\": null,\n \"external_customer_id\": null,\n \"business_id\": null,\n \"contact_person\": null,\n \"custtype\": \"B\",\n \"contact_phone_number\": null,\n \"contact_email_address\": null,\n \"fax_number\": null,\n \"home_url\": null,\n \"country\": \"FIN\",\n \"contact_note\": null,\n \"linked_organization\": null,\n \"external_customer_id2\": null\n }\n]"}],"_postman_id":"9a80aa9f-3320-49e5-984a-73d513cdac81"},{"name":"Create Organization","id":"0dc350a9-7d6d-4967-9390-346861b5aaa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"company_name\": \"New Organization 2\",\r\n\t\"parent_org_id\": 1202,\r\n \"addr_street1\": \"street address\"\r\n}"},"url":"https://api.goodsign.cloud/api/interface/gsapi/organization/actions","description":"Used to Create an organization.
\nUpdate organization. Note that to update and organization always get the full data first and return all elements in the body. Parameters not incuded in the body will be updated to NULL.
\nRequired Parameter:
\n\norg_id | Organization ID |
Additional Parameters:
\n\ncompany_name | Company Name |
parent_org_id | Parent Organization ID |
addr_street1 | Street Address |
addr_street2 | Post Box |
addr_zipcode | ZIP Code |
addr_city | City |
sc_site_code | SC Site Code |
external_customer_id | External Customer ID |
external_customer_id2 | External Customer ID 2 |
business_id | Business ID |
contact_person | Contact Person |
contact_phone_number | Contact Phone Number |
contact_email_address | Contact Email Address |
fax_number | Fax Number |
home_url | Home URL |
country | Country |
contact_note | Contact Note |
custtype | Customer Type |
linked_organization | Linked Organization ID |
Mark an organization deleted. Organizations with child organizations can not be deleted. Use with caution.
\nRequired Parameter:
\n\norg_id | Organization ID |
org_id to be deleted
\n","type":"text/plain"},"key":"org_id","value":"999999"}],"variable":[]}},"response":[{"id":"d5bbc0ce-8612-4503-afcf-c0b64642e1eb","name":"Delete Organization","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"org_id\": \"1208\"\r\n}"},"url":"https://api.goodsign.cloud/api/interface/gsapi/organization/actions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"VompApiToken","value":"NzZhM2I4NzktMzA3Yy00YmU1LWFjNmMtNWM0NWQ3ZDFkNTBm"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 01 Oct 2020 14:30:44 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"rettext\": \"Organization 1208 deleted.\"\n }\n]"}],"_postman_id":"9352786c-611f-4e8e-bcb9-f184c9b96c50"}],"id":"112a5cae-69ce-4907-a7e8-dff4bb17a09f","description":"Organizations in Good Sign typically represent companies. Most organizations represent customers, but also selling company, suppliers, partners and internal organizations can be represented. Additionally organization entities are used as levels in the organization hierarcy to group organizations for various purposes depending on the business logic. Each organization has a parent organization, and this chain represents the full hierarchy.
\nOrganizations are uniquely identified by their org_id.
\n","_postman_id":"112a5cae-69ce-4907-a7e8-dff4bb17a09f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Required Parameter:
\norg_id | \n Organization ID | \n organization | \n Organization full path | \n
Additional Parameter:
\ncostcentre | \n Costcentre | \n
inherit | \n Inherit (show setting on organizations starting from org_id path) | \n
Required Parameter:
\norg_id | \n Organization ID | \n
Additional Parameters:
\ncostcentre | \n Costcentre | \n
eBillable | \n Invoice Type | \n
eBilling_Address | \n Invoicing Account | \n
eBilling_Operator | \n Invoicing Operator | \n
billingperiod_id | \n Payment Period | \n
payment_term_id | \n Payment Term | \n
interest_percentage | \n Interest Percentage | \n
invoice_language | \n Invoice Language | \n
billing_reference | \n Reference | \n
sales_organization | \n Sales Organization | \n
distribution_channel | \n Distribution Channel | \n
division | \n Sales Division | \n
sales_office | \n Sales Office | \n
sales_group | \n Sales Group | \n
sales_account | \n Sales Account | \n
ebilling_from_party | \n Invoice From Address | \n
ebilling_to_party | \n Invoice To Address | \n
billing_reference_prefix | \n Reference Prefix | \n
billing_alternate_cust_name | \n Invoicing Name | \n
no_reminders | \n No Reminder Invoices | \n
no_collects | \n No Collects | \n
no_billing | \n No Invoicing | \n
no_sale | \n No Sale | \n
billing_emailaddress | \n Invoice Email | \n
consolidated_company | \n Consolidated Company | \n
comment | \n Comment | \n
aoka_id | \n AOKA ID | \n
sales_warehouse | \n Sales Warehouse | \n
sales_cost_account | \n Sales Cost Account | \n
sales_cost_costcentre | \n Sales Cost Costcentre | \n
addr_street1 | \n Street Address | \n
addr_street2 | \n Post Box | \n
addr_zipcode | \n ZIP Code | \n
addr_city | \n City | \n
country | \n Country | \n
home_town | \n Home Town | \n
custtype | \n Customer Type | \n
invoice_type | \n Alternate Invoice Type? | \n
customer_vat_id | \n Customer VatID | \n
Required Parameter:
\norg_id | \n Organization ID | \n
Additional Parameters:
\ncostcentre | \n Costcentre | \n
eBillable | \n Invoice Type | \n
eBilling_Address | \n Invoicing Account | \n
eBilling_Operator | \n Invoicing Operator | \n
billingperiod_id | \n Payment Period | \n
payment_term_id | \n Payment Term | \n
interest_percentage | \n Interest Percentage | \n
invoice_language | \n Invoice Language | \n
billing_reference | \n Reference | \n
sales_organization | \n Sales Organization | \n
distribution_channel | \n Distribution Channel | \n
division | \n Sales Division | \n
sales_office | \n Sales Office | \n
sales_group | \n Sales Group | \n
sales_account | \n Sales Account | \n
ebilling_from_party | \n Invoice From Address | \n
ebilling_to_party | \n Invoice To Address | \n
billing_reference_prefix | \n Reference Prefix | \n
billing_alternate_cust_name | \n Invoicing Name | \n
no_reminders | \n No Reminder Invoices | \n
no_collects | \n No Collects | \n
no_billing | \n No Invoicing | \n
no_sale | \n No Sale | \n
billing_emailaddress | \n Invoice Email | \n
consolidated_company | \n Consolidated Company | \n
comment | \n Comment | \n
aoka_id | \n AOKA ID | \n
sales_warehouse | \n Sales Warehouse | \n
sales_cost_account | \n Sales Cost Account | \n
sales_cost_costcentre | \n Sales Cost Costcentre | \n
addr_street1 | \n Street Address | \n
addr_street2 | \n Post Box | \n
addr_zipcode | \n ZIP Code | \n
addr_city | \n City | \n
country | \n Country | \n
home_town | \n Home Town | \n
custtype | \n Customer Type | \n
invoice_type | \n Alternate Invoice Type | \n
customer_vat_id | \n Customer VatID | \n
Required Parameter:
\norg_id | \n Organization ID | \n
Additional Parameter:
\ncostcentre | \n Costcentre | \n
Organization billing information is data for invoicing, such as billing addresses, payment terms, invoicing languages etc.
\n","_postman_id":"32f3899c-2356-41c1-892c-0d3affda4b6a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Required Parameter:
\norg_id | \n Organization ID | \n
Additional Parameter:
\nhierarchy | \n Search suborganizations also if 1. Default: 1 | \n
One of the following is required:
\nu_id | \n User ID | \n
email_address | \n Email Address | \n
external_u_id | \n External User ID | \n
Required parameters:
\norg_id | \n Organization ID | \n
Additional parameters:
\nfirstname | \n Firstname | \n
lastname | \n Lastname | \n
email_address | \n Email Address | \n
contact_tel | \n Contact Telephone | \n
external_u_id | \n External User ID | \n
costcentre | \n Costcentre | \n
u_type_id | \n User Type ID | \n
One of the following is required:
\nu_id | \n User ID | \n
external_u_id | \n External User ID | \n
objectID | \n Object ID | \n
email_address | \n Email Address | \n
Additional parameters:
\nfirstname | \n Firstname | \n
lastname | \n Lastname | \n
contact_tel | \n Contact Telephone | \n
contact_email | \n Contact Email | \n
costcentre | \n Costcentre | \n
org_id | \n Organization ID. Switches user's organization if given and not user's current one. Requires access rights to both current and new organization | \n
Required parameter:
\nu_id | \n User ID | \n
Additional parameter:
\norg_id | \n Organization ID | \n
Users represent user of a service and user always belongs to an organization. User can for example represent the person holding an asset such like computer, and allows more detailed management capabilities for objects and even invoicing. The user may also separately be granted a login to Good Sign; but even then the login is merely linked the user.
\n","_postman_id":"c49db163-03f6-43c7-ae29-2f0012e9340a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Method the get the countrycodes defined in the instance. For instance the billing_country_id value is needed in Posting new organization; or to resolve country name. Also, useful method to map source system two letter countrycodes to three letter codes.
\nbilling_country_id | Country ID |
alpha2code | alpha2code |
Three letter countrycode ; used as optional search parameter
\n","type":"text/plain"},"key":"billing_country_id","value":"FIN"},{"disabled":true,"description":{"content":"Two letter countrycode ; used as optional search parameter
\n","type":"text/plain"},"key":"alpha2code","value":"FI"}],"variable":[]}},"response":[{"id":"53ed7f5e-c507-4a1e-844a-7681193a7c10","name":"List Countrycodes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.goodsign.cloud/api/interface/gsapi/countrycodes/list","protocol":"https","host":["api","goodsign","cloud"],"path":["api","interface","gsapi","countrycodes","list"],"query":[{"key":"billing_country_id","value":"FIN","description":"Three letter countrycodeRequired Parameter:
\norg_id | \n Organization ID | \n
Additional Parameters:
\nproductcode | \n Product Code (cust_code) (can be wildcarded with %) | \n
productcategory | \n Product Category (calltype_id) | \n
hierarchy | \n Search suborganizations also if 1. Default: 1 | \n
languageid | \n Language ID | \n
Product code <string%> you can use wildcard
\n","type":"text/plain"},"key":"productcode","value":"ExampleProdu%"},{"disabled":true,"description":{"content":"Product category
\n","type":"text/plain"},"key":"productcategory","value":"10"}],"variable":[]}},"response":[],"_postman_id":"c1cb124c-5787-4db4-a76c-2b6847c6c50f"},{"name":"Create Product","id":"fa0f3a99-af51-4b4a-a515-150ceabebeb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":" {\r\n \"org_id\": null,\r\n \"productCode\": \"ExampleProduct\",\r\n \"cust_descr\": \"Example Product\",\r\n \"productcategory\": 10,\r\n \"cust_product_group_name\": \"Example Product Group Name\",\r\n \"cust_product_group\": \"Example Product Group\"\r\n }"},"url":"https://api.goodsign.cloud/api/interface/gsapi/product/actions","description":"Create a new product.
\nRequired Parameter:
\nproduct | \n Product Code(key) | \n
cust_descr | \n Product Description | \n
productcategory | \n Product Category Code (calltype_id) | \n
Additional Parameters:
\norg_id | \n Products are created to root organization per default. Specify if needed. | \n \n
cust_product_group | \n Product detailed grouping (used in invoicing) | \n
cust_product_group | \n Product detailed group name (description) | \n
operator_sub_id | \n Subcategory for calltype_id, zero is omitted. | \n
Update product.
\nFrom version 2023_1 onwards, it is possible to change the product category (calltype_id) when updating the product if the product has no existing charges.
\nRequired Parameter:
\nAdditional Parameters:
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Versions: 2022/2 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Product Code
\n","type":"text/plain"},"key":"productcode","value":"2004"},{"disabled":true,"description":{"content":"Productdetail ID
\n","type":"text/plain"},"key":"productdetail_id","value":"35"},{"disabled":true,"description":{"content":"Language ID (dimension)
\n","type":"text/plain"},"key":"language_id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"8b67d731-e4a3-4d6a-8dc3-7e0204d707c2"},{"name":"Update ProductDetail","id":"eced0cf4-115d-45a0-862b-93755a360069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":" {\r\n \"productdetail_id\": 35,\r\n \"productcode\": \"2004\",\r\n \"language_id\": 1,\r\n \"language_descr\": \"Finnish\",\r\n \"cust_descr\": \"updated Shared car trip fee\",\r\n \"cust_product_group\": null,\r\n \"cust_product_group_name\": null,\r\n \"cust_ext_code\": null,\r\n \"cr_account\": null,\r\n \"db_account\": null,\r\n \"cr_cost_centre\": null,\r\n \"db_cost_centre\": null,\r\n \"validfrom\": \"1900-01-01 00:00:00\",\r\n \"validto\": \"2999-12-31 23:59:59\",\r\n \"show_in_invoices\": null,\r\n \"inherit\": 1,\r\n \"cost_share\": null,\r\n \"uplift\": null,\r\n \"show_in_reports\": null,\r\n \"use_pricelist_descr\": null,\r\n \"mandatory_product\": null,\r\n \"invoicing_group\": null,\r\n \"use_price_per_unit\": null,\r\n \"use_billingobject_amount\": null\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.goodsign.cloud/api/interface/gsapi/productdetail/actions","description":"Versions: 2022/2 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Versions: 2022/2 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Products represent intangible or tangible items that are priced, charged and invoiced in Good Sign.
\n","_postman_id":"4ebe569b-3141-47a8-a149-36fc49a7e2cf","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Full documentation:
https://support.goodsign.com/gsapi-data-importing-interface-import
Returns the list of fields supported by the interface, including their types and whether they are key fields.
This is useful for checking the staging table structure before performing imports.
Full documentation:
https://support.goodsign.com/gsapi-data-importing-interface-import
Browse objects (devices,configuration items, servers etc) with different types of filter. Parameters are used with AND condition.
\nRequired parameter:
\n\norg_id | Organization ID |
One of the following is required:
\n\ntype_id | Type ID |
profile_id | Profile ID |
objectid | Object ID |
Additional parameters:
\n\nu_id | User ID (not used) |
objectkey | Object Identifier |
objectname | Object Name |
enrichwith | Enrich the query with e.g. an OUTER APPLY |
where | Custom WHERE condition |
Organization root to search from (includes all child organizations) - Mandatory
\n","type":"text/plain"},"key":"org_id","value":"0"},{"description":{"content":"Type Filters the listed objects by type (without type an empty dataset is returned)
\n","type":"text/plain"},"key":"type_id","value":"70"},{"disabled":true,"description":{"content":"Objectid Filters the list to single object. Giving objectid you can leave type_id out.
\n","type":"text/plain"},"key":"objectid","value":"-31"},{"disabled":true,"description":{"content":"Profile Filters the list to profile.
\n","type":"text/plain"},"key":"profile_id","value":"70"},{"disabled":true,"description":{"content":"Object key . With objectkey you must supply also type and/or profile
\n","type":"text/plain"},"key":"objectkey","value":"C000000001"},{"disabled":true,"description":{"content":"Object name with objectkey you must supply also type and/or profile
\n","type":"text/plain"},"key":"objectname","value":"General Contract"}],"variable":[]}},"response":[{"id":"e2bdfd8c-aad9-4167-a4c6-bbf9891677f6","name":"List Objects","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.goodsign.cloud/api/interface/gsapi/objects/list?org_id=0&type_id=70","protocol":"https","host":["api","goodsign","cloud"],"path":["api","interface","gsapi","objects","list"],"query":[{"key":"org_id","value":"0","description":"Organization root to search from (hierarcial downwards)"},{"key":"type_id","value":"70"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"VompApiToken","value":"MjI0NzJlYjQtNGIyYy00YjE0LTkxNmMtMTRkMTE3NjhjYzc4"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 01 Oct 2020 13:50:29 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"objectname\": \"CL-000000001\",\n \"objectkey\": \"CL-000000001\",\n \"profile_id\": 71,\n \"profilename\": \"Contract Line\",\n \"u_id\": 105,\n \"org_id\": 101,\n \"objectid\": -28,\n \"objectfields\": {\n \"Aggregate_grid_71\": \"\",\n \"Quota\": \"\",\n \"ContractLinePrice\": \"\",\n \"Coverage\": \"\",\n \"ContractLineId\": \"C-000000002-001\",\n \"ContractValidFrom\": \"2020-10-01T00:00:00\",\n \"TerminationPeriod\": \"12\",\n \"ContractSubject\": \"\",\n \"Quantity\": \"12\",\n \"grid_link\": \"10125\",\n \"QuotaPeriod\": \"\",\n \"InvoicedAsLine\": \"1\",\n \"ConfigurationItems\": \"\",\n \"pricingmodel\": \"1\",\n \"Aggregation\": \"0\",\n \"chargetype\": \"1\",\n \"Service\": \"\",\n \"ContractLineValidFrom\": \"2020-10-01T00:00:00\",\n \"ContractStatus\": \"-1\",\n \"ContractDescription\": \"\",\n \"INIT.PROCEDURE\": \"\",\n \"ContractTerm\": \"\",\n \"ContractID\": \"C-000000002\",\n \"pricinglines\": \"\",\n \"VALIDATOR.PROCEDURE\": \"ppv_type70_validator\"\n }\n },\n {\n \"objectname\": \"C-000000002\",\n \"objectkey\": \"C-000000002\",\n \"profile_id\": 70,\n \"profilename\": \"Contract\",\n \"u_id\": 105,\n \"org_id\": 101,\n \"objectid\": -27,\n \"objectfields\": {\n \"comment\": \"Just for demo purposes\",\n \"ContractValidFrom\": \"2020-10-01T00:00:00\",\n \"TerminationPeriod\": \"12\",\n \"ContractSubject\": \"\",\n \"attachments\": \"\",\n \"ContractStatus\": \"-1\",\n \"ContractDescription\": \"Test Contract in Test Organization\",\n \"ContractLines\": \"\",\n \"INIT.PROCEDURE\": \"\",\n \"ContractTerm\": \"\",\n \"ContractID\": \"C-000000002\",\n \"VALIDATOR.PROCEDURE\": \"ppv_type70_validator\"\n }\n }\n]"}],"_postman_id":"9775f6ba-a0d4-4032-98f0-a1b0a0db3dff"},{"name":"Get Object","id":"a12345b0-8f97-4541-bc4e-14717ca18fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.goodsign.cloud/api/interface/gsapi/object/actions?objectkey=CL-000000001&profile_id=71","description":"One of the following is required:
\nobjectid | \n Object ID | \n
objectkey | \n Object Identifier | \n
objectname | \n Object Name | \n
Also required if objectid is not given:
\nprofile_id | \n Profile ID. | \n
Required parameters:
\nprofile_id | \n Profile ID | \n
objectkey | \n Object Identifier | \n
One of the following is required:
\norg_id | \n Organization ID | \n
u_id | \n User ID | \n
Additional parameters:
\nobjectname | \n Object Name | \n
starttime | \n Start Time. Is set to current time if not given | \n
objectfields | \n \n \n Field Name and Value pairs: \n \n {\n \"field_name\": \"test\",\n \"value\": \"test\"\n },\n {\n \"field_name\": \"test2\",\n \"value\": \"test2\"\n },\n ...\n \n | \n
One of the following is required:
\nobjectid | \n Object ID | \n
objectkey | \n Object Identifier | \n
Also required if objectid is not given:
\nprofile_id | \n Profile ID | \n
Additional parameters:
'\nNote that with this method only the field names present in the body are affected; so to update only one field you can do it. But if you introduce all fields - beware all field values will update so make sure to have the current value.
\nobjectfields | \n \n \n Field Name and Value pairs: \n \n {\n \"field_name\": \"test\",\n \"value\": \"test\"\n },\n {\n \"field_name\": \"test2\",\n \"value\": \"test2\"\n },\n ...\n \n | \n
One of the following is required:
\nobjectid | \n Object ID | \n
objectkey | \n Object Identifier | \n
Also required if objectid is not given:
\nprofile_id | \n Profile ID | \n
Parameters:
\n\n\neither id or key must be presented
\n
\n\nif new_org_id is only presented, object will be
\n
assigned to organization default user
\n\nif timestamp is given , object will be automatically
\n
repriced based on rules and prices
Shows a list of profiles filtered by type_id or profile_id. Available in coming Good Sign release 2024_1.
\nResponse values
\nprofile_id (number): The ID of the profile.descr (string): The description of the profile.custtype_id (string): The customer type ID.id_autogenerate (null): Is the profile identity autogenerated or decided by data.id_prefix (string): Prefix for the ID.id_suffix (string): Suffix for the ID.id_length (integer): Length of the ID.layout_formatted (integer): Defines whether the profile diplaying only parameters or designed form.deleted (int): 1 means deletedhelp_link (null): URL the help documentation.type_id (number): Type ID of the profile.type_descr (string): Description of the type.show_in_list (boolean): Indicates whether the profile should be shown in the list.icon_class_name (string): Class name for the icon.Objects in Good Sign are dynamic data objects, that have a unique Object_id. Objects are always connected to an Organization with a validity period to this relation. Objects are categorized to a type; and type can be further separated with a profile. As an example, if type is a server, profile could be like Linux Server, Windows Server of VmWare server. They share a common set of parameters but still have own individual distinctions. Objects are typically used in Good Sign to store and represent data that is used by the rule engine in the charging and billing process.
\nObjects can store any amount of parameters (\"field values\"), of which are common to type level, but can be filtered on profile level.
\nObject methods manage objects.
\n","_postman_id":"d43657c4-6e81-4117-9e8b-6ee079d5177a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Browse Contracts
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Organization browse root org_id (0=root)
\n","type":"text/plain"},"key":"org_id","value":"0"}],"variable":[]}},"response":[{"id":"a5144677-a661-4dc2-985c-794456b9fa4f","name":"List Contracts","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.goodsign.cloud/api/interface/gsapi/contracts/list?org_id=0","protocol":"https","host":["api","goodsign","cloud"],"path":["api","interface","gsapi","contracts","list"],"query":[{"key":"org_id","value":"0","description":"Organization browse root org_id (0=root)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"VompApiToken","value":"MjA4MTgwNjctMzA1NS00ODg1LWI4ZGUtMDg4ZjM4Njc2Zjlh"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 08 Oct 2020 12:49:42 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Company\": \"Test organization\",\n \"ContractID\": \"C-000000002\",\n \"objectkey\": \"C-000000002\",\n \"org_id\": 101,\n \"ContractStatus\": \"Draft\",\n \"ContractValidFrom\": \"2020-10-01T00:00:00\",\n \"TerminationPeriod\": \"12\",\n \"ContractSubject\": \"Just a subject\",\n \"ContractDescription\": \"Test Contract in Test Organization\",\n \"Comment\": \"Just for demo purposes\",\n \"ContractLines\": {\n \"contractLineID\": \"CL-000000001\"\n }\n },\n {\n \"Company\": \"Test organization\",\n \"ContractID\": \"C-000000003\",\n \"objectkey\": \"C-000000003\",\n \"org_id\": 101,\n \"ContractValidFrom\": \"2020-10-01 00:00:00\",\n \"ContractValidTo\": \"2999-12-31 23:59:59\",\n \"TerminationPeriod\": \"12\",\n \"ContractSubject\": \"Just a another subject\",\n \"ContractDescription\": \"New Test Contract in Test Organization\"\n },\n {\n \"Company\": \"Test organization\",\n \"ContractID\": \"Sobimus\",\n \"objectkey\": \"C-000000004\",\n \"org_id\": 101,\n \"ContractValidFrom\": \"2020-10-01 00:00:00\",\n \"ContractValidTo\": \"2999-12-31 23:59:59\",\n \"TerminationPeriod\": \"12\",\n \"ContractSubject\": \"Just a another subject\",\n \"ContractDescription\": \"New Test Contract in Test Organization\"\n },\n {\n \"Company\": \"Test organization\",\n \"ContractID\": \"Sobximsus\",\n \"objectkey\": \"C-000000006\",\n \"org_id\": 101,\n \"ContractStatus\": \"Active\",\n \"ContractValidFrom\": \"2020-10-01 00:00:00\",\n \"ContractValidTo\": \"2999-12-31 23:59:59\",\n \"TerminationPeriod\": \"12\",\n \"ContractSubject\": \"Just a another subject\",\n \"ContractDescription\": \"New Test Contract in Test Organization\",\n \"Comment\": \"Just for demo purposes again\"\n },\n {\n \"Company\": \"Test organization\",\n \"ContractID\": \"Sobximus\",\n \"objectkey\": \"C-000000005\",\n \"org_id\": 101,\n \"ContractStatus\": \"Active\",\n \"ContractValidFrom\": \"2020-10-01 00:00:00\",\n \"ContractValidTo\": \"2999-12-31 23:59:59\",\n \"TerminationPeriod\": \"12\",\n \"ContractSubject\": \"Just a another subject\",\n \"ContractDescription\": \"New Test Contract in Test Organization\",\n \"Comment\": \"Just for demo purposes again\"\n }\n]"}],"_postman_id":"9f998c1b-b518-4240-bfd7-48ae9b899ccb"},{"name":"Create Contract","id":"8c343a25-1ff3-488b-8c7b-07de93cc26b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ContractID\": \"General Contract\",\r\n \"org_id\": 101,\r\n \"ContractStatus\": \"Active\",\r\n \"ContractValidFrom\": \"2020-10-01T00:00:00\",\r\n \"TerminationPeriod\": \"12\",\r\n \"ContractSubject\": \"Just a another subject\",\r\n \"ContractDescription\": \"New Test Contract in Test Organization\",\r\n \"Comment\": \"Just for demo purposes again\"\r\n }"},"url":"https://api.goodsign.cloud/api/interface/gsapi/contract/actions","description":"Adds a new contract to organization.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Updates a contract. Use Contracts list to get the complete JSON before updating, \notherwise the other values will be overwritten.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The method gives you ability to list the Contract Lines. org_id is mandatory parameter and it shows contract lines from the given org_id and its children in the organization tree.
\nAlternatively you can give the Organization with the Full Paht as Text.
\nContractID isadditional filter parameter, use when you simply want to list lines of a given contract. ContractID filtering available from Good Sign version 2022_2 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Organization browse root org_id (0=root)
\n","type":"text/plain"},"key":"org_id","value":"0"},{"disabled":true,"description":{"content":"Full path to organization
\n","type":"text/plain"},"key":"Organization","value":""},{"disabled":true,"description":{"content":"FIlter contract lines by single ContractID
\n","type":"text/plain"},"key":"ContractID","value":""}],"variable":[]}},"response":[{"id":"8ae20e3d-48b9-48f8-a065-66f510fc7e56","name":"List Contract Lines","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.goodsign.cloud/api/interface/gsapi/contractlines/list?org_id=0","protocol":"https","host":["api","goodsign","cloud"],"path":["api","interface","gsapi","contractlines","list"],"query":[{"key":"org_id","value":"0","description":"Organization browse root org_id (0=root)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"VompApiToken","value":"M2Q3ZDYyY2YtODA4MC00OTY2LTkzOTgtY2UzZjgxMGQ0ZmU4"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 08 Oct 2020 12:33:23 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Company\": \"Test organization\",\n \"ContractLineID\": \"C-000000002-001\",\n \"objectkey\": \"CL-000000001\",\n \"ContractID\": \"C-000000002\",\n \"org_id\": 101,\n \"ContractLineValidFrom\": \"2020-10-01T00:00:00\",\n \"Service\": \"\",\n \"Quantity\": \"12\",\n \"ChargeModel\": \"Usage\",\n \"Chargetype\": \"Recurring\",\n \"Aggregation\": \"No\",\n \"PricingModel\": \"Unit\"\n }\n]"}],"_postman_id":"9aa725a2-7b8f-42af-9e6f-18dd53fa0326"},{"name":"Create Contract Line","id":"d1b3d7c2-20de-4fe2-9db7-256c4939e813","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":" {\r\n \"ContractID\": \"C-000000002\",\r\n \"ContractLineProfileID\" : 75,\r\n \"contractLineProfile\": null,\r\n \"org_id\": 101,\r\n \"ContractLineDescription\": \"Defines the charge for the server\",\r\n \"ContractLineValidFrom\": \"2020-10-01T00:00:00\",\r\n \"Service\": \"PRODUCT1\",\r\n \"Quantity\": \"12\",\r\n \"ChargeModel\": \"Predefined\",\r\n \"Chargetype\": \"Recurring\",\r\n \"Aggregation\": \"No\",\r\n \"PricingModel\": \"Unit\",\r\n \"MappingValues\": \"\"\r\n }"},"url":"https://api.goodsign.cloud/api/interface/gsapi/contractline/actions","description":"Creates a new contract line. ContractID must be present in order to attach line to contract header. Important to give the ContractLineProfileID to ensure correct business logic. Use list object profles method for type_id 70 to get list of profiles.
\nIn short the most typical profiles.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Api Calls for maintaining and listing contract lines
\n","_postman_id":"652cb610-71ab-4f84-b336-4d52d21360db","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Imports one or more contract transactions into Good Sign.
Transactions represent measurable usage that contract lines consume.
Each transaction must be inside a JSON array.
Each item contains fields such as transactionId, timestamp, quantity, mappingValue,
and optional dimensions.
If your system does not provide transactionId values, use:
?GenTransactionId=1
and omit the transactionId field from the payload.
Full documentation:
https://support.goodsign.com/gsapi-data-import-contract-events
Imports contract transactions and automatically generates transactionId values.
Use this version of the endpoint when your source system does not produce unique IDs.
Each item in the JSON array must contain:
- timestamp
- quantity
- mappingValue
Do not include transactionId when using ?GenTransactionId=1.
\nFull documentation:
https://support.goodsign.com/gsapi-data-import-contract-events
Values from template are used unless the POST body overrides them.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Depending on charging model it possible to send usage data that is linked to specified contract line.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Depending on charging model it possible to send usage data that is linked to specified contract line. This endpoint allows to send multiple events in array.
\nPlease note that this API does not check validity of mapping values and their correspondence to contract line. In other words – if you input data with values that don’t match any defined mappings, those entries will remain in the usage aggregate table as unmapped events.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Values: 0, 1 (default). Value 1 means that Good Sign processes the imported data immediately after import. With large multiple API imports set this to 1 for last batch only if possible.
\n","type":"text/plain"},"key":"notify","value":"1"}],"variable":[]}},"response":[],"_postman_id":"bdda6dd9-5696-425d-ab32-65c7c27775ff"}],"id":"0954a3ac-f850-426e-8957-a8433de876d1","_postman_id":"0954a3ac-f850-426e-8957-a8433de876d1","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Contract model API is for the Packaged Good sign contract model that is a ready made business model to enable typical business and pricing models including subscriptions, one time fees, transaction billing.
\n","event":[{"listen":"prerequest","script":{"id":"b26de062-d787-49d2-b6f0-1059f0acc65b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7440b179-818e-46c2-8dac-fa43db43fe32","type":"text/javascript","exec":[""]}}],"_postman_id":"7d7f5fd5-a491-4a56-adf0-a96757b8a86e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Organization id. 0 for Root.
\n","type":"text/plain"},"key":"org_id","value":"0"},{"description":{"content":"Start date of the request
\n","type":"text/plain"},"key":"starttime","value":"2020-08-01"}],"variable":[]}},"response":[],"_postman_id":"bb47b95c-0572-4fc2-bcbc-4bca818a58c4"},{"name":"Add a Charge","id":"f52a08a4-df73-4481-9fe9-43063e7bdec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" {\n \"Organization\": \"Leasingdale Ltd\",\n \"ObjectID\": null,\n \"UserID\": null,\n \"Product\": \"1010\",\n \"Amount\": 2.5,\n \"Charge\": 4,\n \"StartTime\": \"2023-09-01 00:00:00\",\n \"EndTime\": \"2023-12-31 23:59:59\",\n\t\t\"Invoice_descr\": \"Charging test\",\n\t\t\"cr_account\": \"Account1234\"\n }"},"url":"https://api.goodsign.cloud/api/interface/gsapi/charges/actions","description":"Adds a charge for item. One of the cursive parameters need to be present.
\nCharge will be issued to the most precise level (Object->User-> Organization) depending on given parameters.
\nUse UserID only if charge is user_based.
\nParameter Details
\nVersions: 2023/2 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Deletes a charge permanently. Direct charge editing is not supported — to modify a charge, delete it and recreate it with the correct values using the POST endpoint.
\nRequired:
\nLists prices per organization level.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Organization full path (if org_id is not introduced)
\n","type":"text/plain"},"key":"organization","value":"Root"},{"description":{"content":"Organization Identifier
\n","type":"text/plain"},"key":"org_id","value":"0"},{"description":{"content":"productcode filter (leave blank to fetch all codes)
\n","type":"text/plain"},"key":"productcode","value":"1020"},{"disabled":true,"description":{"content":"1 include also expired prices without or with 0 will show all prices that have not yet expired. But they may also not yet be valid.
\n","type":"text/plain"},"key":"valid_filter","value":""},{"key":"filtermask","value":null}],"variable":[]}},"response":[{"id":"d798dc73-42c8-425b-bf5d-4a0aec9a764f","name":"List Prices","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.goodsign.cloud/api/interface/gsapi/pricings/list?organization=Root","protocol":"https","host":["api","goodsign","cloud"],"path":["api","interface","gsapi","pricings","list"],"query":[{"key":"organization","value":"Root","description":"Organization full path (if org_id is not introduced)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"VompApiToken","value":"MmI1OWI0MDctZTdjZi00MWNlLWIyYWYtYjZmYWE3NWI2ZGI3"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 16 Jun 2021 07:58:46 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"PricelistOrganization\": \"Leasingdale Ltd/Business Customers/Claire's Candyshop\",\n \"pricing_id\": 12,\n \"productcode\": \"1020\",\n \"descr\": \"Skoda Octavia base fee\",\n \"PricingModel\": \"Unit\",\n \"min_amount\": null,\n \"max_amount\": null,\n \"price\": 689.85,\n \"pricevalidfrom\": \"2021-03-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1210,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd/Business Customers/Lisa's Café\",\n \"pricing_id\": 11,\n \"productcode\": \"2001\",\n \"descr\": \"Extra km\",\n \"PricingModel\": \"Tier\",\n \"min_amount\": 1001,\n \"max_amount\": 99999999999,\n \"price\": 0.22,\n \"pricevalidfrom\": \"2021-01-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1208,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd/Business Customers/Lisa's Café\",\n \"pricing_id\": 10,\n \"productcode\": \"2001\",\n \"descr\": \"Extra km\",\n \"PricingModel\": \"Tier\",\n \"min_amount\": 1,\n \"max_amount\": 1000,\n \"price\": 0,\n \"pricevalidfrom\": \"2021-01-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1208,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd/Business Customers\",\n \"pricing_id\": 5,\n \"productcode\": \"1010\",\n \"descr\": \"MB 300e base fee\",\n \"PricingModel\": \"Unit\",\n \"min_amount\": null,\n \"max_amount\": null,\n \"price\": 595,\n \"pricevalidfrom\": \"2021-04-01T00:00:00+03:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1205,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd/Business Customers\",\n \"pricing_id\": 6,\n \"productcode\": \"2001\",\n \"descr\": \"Extra km\",\n \"PricingModel\": \"Tier\",\n \"min_amount\": 1501,\n \"max_amount\": 999999999999,\n \"price\": 0.14,\n \"pricevalidfrom\": \"2021-01-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1205,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd/Business Customers\",\n \"pricing_id\": 9,\n \"productcode\": \"2001\",\n \"descr\": \"Extra km\",\n \"PricingModel\": \"Tier\",\n \"min_amount\": 1,\n \"max_amount\": 1500,\n \"price\": 0,\n \"pricevalidfrom\": \"2021-01-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1205,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd\",\n \"pricing_id\": 8,\n \"productcode\": \"1030\",\n \"descr\": \"Toyota RAV4 base fee\",\n \"PricingModel\": \"Unit\",\n \"min_amount\": null,\n \"max_amount\": null,\n \"price\": 1008.1,\n \"pricevalidfrom\": \"2021-01-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1202,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd\",\n \"pricing_id\": 7,\n \"productcode\": \"1020\",\n \"descr\": \"Skoda Octavia base fee\",\n \"PricingModel\": \"Unit\",\n \"min_amount\": null,\n \"max_amount\": null,\n \"price\": 766.5,\n \"pricevalidfrom\": \"2021-01-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1202,\n \"CurrentOrgID\": 0\n },\n {\n \"PricelistOrganization\": \"Leasingdale Ltd\",\n \"pricing_id\": 13,\n \"productcode\": \"2004\",\n \"descr\": \"Shared car trip fee\",\n \"PricingModel\": \"Unit\",\n \"min_amount\": null,\n \"max_amount\": null,\n \"price\": 2.5,\n \"pricevalidfrom\": \"2021-01-01T00:00:00+02:00\",\n \"pricevalidto\": \"2998-12-31T23:59:59.997+02:00\",\n \"currency\": \"EUR\",\n \"PricelistOrgID\": 1202,\n \"CurrentOrgID\": 0\n }\n]"}],"_postman_id":"6b6d8f27-67fd-4007-bb7e-e002df9d88a1"},{"name":"Get Price","id":"29126a37-8189-4ef4-91bc-f12ed863ad26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Create a new price.
\nVersion 2024_2 onwards added
\n\"vatpercentage\". This is Tax % in UI
\n\"vat\". This is Tax ID from Tax Rate table and is converted to tax percentage to the UI field Price Includes Tax
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Update Price
\nVersion 2024_2 onwards added
\n\"vatpercentage\". This is Tax % in UI
\n\"vat\". This is Tax ID from Tax Rate table and is converted to tax percentage to the UI field Price Includes Tax
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Version 2024_2 onwards
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Optional: To list specific products
\n","type":"text/plain"},"key":"productcode","value":null},{"disabled":true,"description":{"content":"Optional: to filter with country (FIN)
\n","type":"text/plain"},"key":"country_id","value":null},{"description":{"content":"Optional: Product category_id
\n","type":"text/plain"},"key":"productcategory","value":null},{"description":{"content":"Optional: Product category name
\n","type":"text/plain"},"key":"productcategoryname","value":null},{"description":{"content":"Optional: Date in iso-format (yyyy-mm-dd)
\n","type":"text/plain"},"key":"date","value":null}],"variable":[]}},"response":[],"_postman_id":"72529109-b182-4a32-bc0b-fc5af920403c"}],"id":"1b3a628f-fcc8-4837-9730-e6fdf9b3d956","description":"This folder contains API functions for listing and managing prices. It is strogly recommended to consult Good Sign before beginning to create and update prices via API.
\n","_postman_id":"1b3a628f-fcc8-4837-9730-e6fdf9b3d956","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns a list of invoice batches for a given organization.
You can filter batches by organization, date range, hierarchy,
delivery method, or invoice schedule rule.
Use this endpoint to monitor invoice schedule runs and check
unsent or failed invoices before sending batches.
Full documentation:
https://support.goodsign.com/gsapi-invoice-batches
Returns detailed information for a single invoice batch.
\nUse batchId to select the batch.
Use detaillevel to control which invoices are returned:
0 = Summary only
1 = All invoices
2 = Only not delivered invoices
3 = Only delivered invoices
4 = Only failed invoices
Typical use cases:
- Inspect the result of an invoice schedule run
- See which invoices failed or are still pending
- Verify batch contents before sending or rollback
Related endpoints:
- GET Invoice Batches – List
- POST Invoice Batch – Send
- DELETE Invoice Batch – Rollback
Full documentation:
https://support.goodsign.com/gsapi-invoice-batches
Sends all eligible invoices in the specified invoice batch.
\nThis operation initiates the delivery process for invoices contained in the batch.
The delivery method (print, e‑invoice, email, etc.) is determined by invoice and
organization configuration.
Recommended flow:
1. List available batches using \"Invoice Batches – List\"
2. Inspect batch contents using \"Invoice Batch – Actions\"
3. Send the batch using this endpoint
Important:
- This is a write and potentially irreversible operation.
- Only invoices that are not yet delivered will be processed.
- Requires Invoice Batch Send rights.
Related endpoints:
- GET Invoice Batches – List
- GET Invoice Batch – Actions
- DELETE Invoice Batch – Rollback
Full documentation:
https://support.goodsign.com/gsapi-invoice-batches
Rolls back an invoice batch and reverts invoices that have not yet been delivered.\nThis operation cancels processing of the specified invoice batch and resets\neligible invoices back to their pre-batch state. It is intended for use\nwhen a batch was created or sent by mistake and delivery has not yet completed.\nImportant:\n- This is a destructive operation.\n- Rollback is only possible before invoices are fully delivered.\n- Delivered invoices cannot be rolled back.\n- Requires Invoice Batch Rollback rights.\nRecommended flow:\n1. List available batches using \"Invoice Batches – List\"\n2. Inspect batch status using \"Invoice Batch – Actions\"\n3. Roll back the batch using this endpoint if delivery has not completed\nRelated endpoints:\n- GET Invoice Batches – List\n- GET Invoice Batch – Actions\n- POST Invoice Batch – Send\nFull documentation:\nhttps://support.goodsign.com/gsapi-invoice-batches\n\nInvoice batches represent groups of invoices generated together as part of a billing or invoicing run. A batch typically corresponds to a scheduled or manually triggered invoicing process and may contain one or more individual invoices.
\nUsing the GSAPI, clients can retrieve invoice batches and then fetch the invoices belonging to a specific batch. This allows external systems to track invoicing runs, correlate invoices created together, and process invoicing data incrementally instead of handling individual invoices in isolation.
\nAuthentication: Access to invoice batch endpoints requires a valid VompApiToken. See the Authentication section in the API Overview for details.
\nIn some environments, webhook notifications may be configured to signal when invoice batches or invoices are ready to be fetched. Webhook availability and configuration depend on system setup and environment.
\n","_postman_id":"213a5a2b-c723-4117-9b56-70e6bddceb46","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Updates the external invoice number on a sent invoice and automatically marks it as Delivered (status 60). Use this when your external invoicing system has assigned a number to an invoice sent from Good Sign.
\nRequired:
\niheader_id
\next_invoice_id and/or ext_invoice_id2 (at least one must be provided)
\nBusiness rule:
\nSetting status to Delivered (60) is automatic — do not include status_id as a parameter.
\nReverse status changes are not supported.
\nRequired rights: 6000 (GSAPI), 6001 (GSAPI write), and invoice-edit rights as configured.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns attachment metadata for a given invoice header.\nResponse includes file name, mime type, size, and a retrieval token or link depending on environment.
\nAuthentication: This endpoint requires a valid VompApiToken. See the Authentication section in the API Overview for details.
\nTypical use cases include retrieving invoice PDF documents and other files generated during the invoicing process after an invoice has been created or delivered.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Invoice Journal shows many different invoicing views - use journaltype-parameter to choose from:
\nSummary – Lists invoices and basic date and price information filtered by invoice date
\nDetail – Lists invoice lines with product, accounting and price information filtered by invoice date
\nAccounting – Lists invoice line information grouped by account information and prices filtered by invoice date
\nFull details – Detailed information on invoice status and all information of invoice lines filtered by invoice date
\nVersions: 2021/2 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Organization full path presentation, filters to given organization only
\n","type":"text/plain"},"key":"organization","value":"ApiDemoCloud"},{"description":{"content":"Mandatory: possible values are Summary|Detail|Accounting|Full
\n","type":"text/plain"},"key":"journaltype","value":"accounting"},{"description":{"content":"Mandatory: Date filter for invoice date, in journaltype full filter works against invoiced service period
\n","type":"text/plain"},"key":"startdate","value":"2021-05-01"},{"description":{"content":"Mandatory: Date filter for invoice date, in journaltype full filter works against invoiced service period
\n","type":"text/plain"},"key":"enddate","value":"2022-05-31 23:59:59"},{"disabled":true,"description":{"content":"Organization is; returns all data from child organizations. Either org_id or organization is required.
\n","type":"text/plain"},"key":"org_id","value":null}],"variable":[]}},"response":[],"_postman_id":"6f03cb66-5cfa-446c-acf2-ebddf150a5e2"},{"name":"Invoice List","id":"b9b808c1-aa82-4dc3-a704-cb192965ffc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.goodsign.cloud/api/interface/gsapi/invoice/list?org_id=0&runendtime=2022-01-01&invoice_id&iheader_id","description":"Lists complete invoice information (invoice, headers, seller) in GS invoice format (JSON)
\nVersion: 2022/1 onwards. Requires also that setup to store the invoice in JSON is in place in the instance.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"organization_id
\n","type":"text/plain"},"key":"org_id","value":"0"},{"description":{"content":"monthly scope from which the invoices are fetched. If omitted the current month is used
\n","type":"text/plain"},"key":"runendtime","value":"2022-01-01"},{"description":{"content":"for fetching invoice by invoice_id
\n","type":"text/plain"},"key":"invoice_id","value":null},{"description":{"content":"for fetching invoice by iheader_id
\n","type":"text/plain"},"key":"iheader_id","value":null}],"variable":[]}},"response":[],"_postman_id":"b9b808c1-aa82-4dc3-a704-cb192965ffc0"},{"name":"Invoice Line List","id":"039fe446-5ea8-403f-8625-b6b82319a69f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.goodsign.cloud/api/interface/gsapi/invoice/line_list?iheader_id=34","description":"Lists the invoice lines of the given invoice , or all invoice lines of the given organization and its child organizations.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Organization id, also gives all child organizations
\n","type":"text/plain"},"key":"org_id","value":"0"},{"description":{"content":"Invoice header id, filtres the invoice lines.
\n","type":"text/plain"},"key":"iheader_id","value":"34"}],"variable":[]}},"response":[],"_postman_id":"039fe446-5ea8-403f-8625-b6b82319a69f"},{"name":"Invoice Charges","id":"e8ffb217-10f8-43c7-8af2-003cc0407383","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.goodsign.cloud/api/interface/gsapi/invoicecharges/list?iheader_id=58","description":"Title: Invoice Charges – List charges for an invoice header
\nDescription:
Returns itemized invoice charge lines for a single invoice header in Good Sign.
Typical use cases are:
Showing invoice line details in a billing UI
\nReconciling invoiced amounts with upstream systems
\nVerifying rating/billing results per contract or subscription
\nAuthentication: This endpoint requires a valid VompApiToken. The token is obtained via the /gsapi/welcome endpoint and must be included in the request headers. See the Authentication section in the API Overview for details.
\nBase URL
\nhttps://api.goodsign.cloud\n\nMethod: GET
Endpoint:
\nGET https://api.goodsign.cloud/api/interface/gsapi/invoicecharges/list\n\nWhen using environment variables:
\nGET {{base_url}}/api/interface/gsapi/invoicecharges/list\n\nExample with query string:
\nGET {{base_url}}/api/interface/gsapi/invoicecharges/list?iheader_id=58\n\nOutput options:
\nThe invoicecharges/list endpoint supports JSON output modes introduced in release 2026_2. By using JsonOut or filtermask, the response can be returned as structured JSON only, including additional fields intended for integration use cases.
\nHTTP status: 200 OK
{\n \"organization\": \"Finara Group/Finara Finland Oy/Xentia Pa...\",\n \"invoicetype\": \"Customer invoice\",\n \"iheader_id\": 58,\n \"invoice_id\": 109,\n \"status\": \"Delivered\",\n \"charges\": [\n {\n \"calldate\": \"2025-04-01T00:00:00\",\n \"objectId\": -64,\n \"objectKey\": \"F000000003\",\n \"objectProfile\": \"Recurring base fee, fixed plan\",\n \"product\": \"10010\",\n \"productCategory\": \"SaaS Subscription Fees\",\n \"price_per_unit\": 1250,\n \"amount\": 1,\n \"price\": 1250,\n \"currency\": \"EUR\",\n \"vat\": 0,\n \"vatpercentage\": 24,\n \"discount\": null,\n \"discountPercentage\": null,\n \"billingobject_id\": 154,\n \"vt_id\": 160,\n \"boparams\": {\n \"invoice_line_note1\": \"01.04.2025 - 31.03.2026\",\n \"ContractId\": \"C000000005\",\n \"ContractLineId\": \"F000000003\",\n \"GS_ChargeStartTime\": \"2025-04-01 00:00:00.000\",\n \"GS_ChargeEndTime\": \"2026-03-31 23:59:59.000\"\n }\n }\n ]\n}\n\norganization (string): Name / path of the organization and sub-entities that own the invoice.
invoicetype (string): Human-readable invoice type, e.g. Customer invoice.
iheader_id (number): Internal invoice header identifier. Echoes the requested iheader_id.
invoice_id (number): External or visible invoice identifier in Good Sign.
status (string): Invoice processing status, e.g. Delivered (already sent to end customer or target system).
charges (array): List of charge line objects included in this invoice.
charges[] FieldsEach element in charges represents a single invoice line / rated charge.
calldate (string, ISO datetime): Start date/time of the charge period or the event date.
objectId (number): Internal ID of the billed object (e.g. contract line, subscription, asset).
objectKey (string): External key or code of the billed object, such as a contract line identifier.
objectProfile (string): Human-readable description of the billed profile (e.g. charging model).
product (string): Product code for the billed item.
productCategory (string): Product category or revenue bucket, e.g. SaaS Subscription Fees.
price_per_unit (number): Unit price before VAT and discounts.
amount (number): Billed quantity (units, months, licenses, etc.).
price (number): Line total (often price_per_unit \\\\\\\\\\\\\\\\* amount minus discounts, excluding VAT unless otherwise configured).
currency (string): ISO currency code of the invoice, e.g. EUR.
vat (number): VAT amount for this line (e.g. 0 if reverse-charged or tax exempt in this example).
vatpercentage (number): Applied VAT percentage, e.g. 24 for 24%.
discount (number or null): Absolute discount amount applied to this line, if any.
discountPercentage (number or null): Discount percentage applied to this line, if any.
billingobject_id (number): Internal billing object ID, usually pointing to the entity that owns the charge.
vt_id (number): Internal ID for the VAT / tax template or similar classification.
boparams (object): Additional business object parameters, often contract-level metadata.
invoice_line_note1 (string): Free-text note printed on the invoice line (e.g. service period).
ContractId (string): Identifier of the related contract.
ContractLineId (string): Identifier of the related contract line.
GS_ChargeStartTime (string): Exact start timestamp of the billed period.
GS_ChargeEndTime (string): Exact end timestamp of the billed period.
Used to post payment transactions to the invoices. Transactions can be matched with invoice ID, invoice number, reference number or external invoice number. The amount of money posted can be passed to the function to detect possible over/underpayments or the invoice can be just closed without monetary value. The transaction codes can be mapped with three external transaction codes for custom purposes.
\nParameter Details
\nTransaction types
\nError codes
\nVersions: 2023/1 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Invoice endpoints provide access to individual invoice data, including invoice headers, lines, charges, attachments, and payment-related operations. These endpoints are typically used after invoices have been created, either individually or as part of an invoice batch.
\n","_postman_id":"0a9b1fc5-b0b1-4795-8da7-f2ddc75fcc74","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Several options for exporting more raw data from the billing database. Options included
\n(option_id)
\nInvoices (1)
Shows invoices with header info
InvoiceLines (2)
Shows invoice lines , can be filtered with invoice_id
Organizations (3)
List of organizations starting from the
organization
OrganizationBillingInfo (4)
Included also billing settings
Products (5)
List products
Prices (6)
\nProductCategories (7)
\nCharges (8)
\nCallTickets (9)
If system has telephone data
Versions: 2021/2 onwards.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Available in 2025_2
\nRetrieves records from a specified database table. Primarily used to browse and filter imported transaction data. Pagination, sorting, and filtering are controlled through the JSON request body.
\nQuery parameters
\nBody parameters
\nWarning: Omitting sortorder when paginating causes silent incorrect results. Every page returns identical records. Always include sortorder when using page.
Total record count is returned in the response header X-GSAPI-QueryTotalCount. Use this to calculate how many pages to fetch.
Filter operators: eq, neq, greater, lower, contains, isnull, isnotnull